org.gcube.indexmanagement.common
Class ForwardIndexType

java.lang.Object
  org.gcube.indexmanagement.common.IndexType
      org.gcube.indexmanagement.common.ForwardIndexType

public class ForwardIndexType
extends IndexType

This class returns the index types that are supported by the ForwardIndex.

Field Summary

ForwardIndexField[]

fields The fields of this GeoIndexType

Fields inherited from class org.gcube.indexmanagement.common.IndexType

APXCOUNT, COLLECTION_FIELD, DOCID_FIELD, DOCNR, GEODEFAULT, GEOFIELD, indexType, indexTypeID, LANGUAGE_FIELD, MBR, PAYLOAD_FIELD, PRESENTABLE_TAG, RATIO, RESULTSNO_EVENT, RESULTSNOFINAL_EVENT, SCORE_FIELD, SEARCHABLE_TAG, SEPERATOR_FIELD_INFO, SNIPPET, STATS_FIELD, WILDCARD

Constructor Summary

ForwardIndexType(String indexTypeName, org.gcube.common.core.scope.GCUBEScope scope)
Standard constructor which build a ForwardIndexType object an index type name

Method Summary

boolean	containsField(String fieldName, ForwardIndexField.DataType fieldDataType) A method to check if this ForwardIndexType object contains a certain field
ForwardIndexField	getKeyField() Returns the object representing the "key" field of this forward index type
ForwardIndexField	getValueField() Returns the object representing the "value" field of this forward index type

Methods inherited from class org.gcube.indexmanagement.common.IndexType

getIndexTypeAsString, getIndexTypeName, retrieveIndexTypeGenericResource, sendIndication

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

fields

public ForwardIndexField[] fields

The fields of this GeoIndexType

Constructor Detail

ForwardIndexType

public ForwardIndexType(String indexTypeName,
                        org.gcube.common.core.scope.GCUBEScope scope)

Standard constructor which build a ForwardIndexType object an index type name

Parameters:

indexTypeName - - The name to assign to the GeoIndexType

scope - - the current scope

Method Detail

containsField

public boolean containsField(String fieldName,
                             ForwardIndexField.DataType fieldDataType)

A method to check if this ForwardIndexType object contains a certain field

Parameters:

fieldName - - The name of the field to look for

fieldDataType - - The DataType of the field to look for

Returns:

- TRUE if this GeoIndexType object contains a field with the specified name and data type

getKeyField

public ForwardIndexField getKeyField()

Returns the object representing the "key" field of this forward index type

Returns:

getValueField

public ForwardIndexField getValueField()

Returns the object representing the "value" field of this forward index type

Returns: