org.gcube.indexmanagement.geo

Class GeoIndexType

java.lang.Object

org.gcube.indexmanagement.common.IndexType

org.gcube.indexmanagement.geo.GeoIndexType

public class GeoIndexType
extends IndexType

A Java object representation of the GeoIndexType

Field Summary

Fields

Modifier and Type	Field and Description
GeoIndexField[]	fields The fields of this GeoIndexType
int	nrOfFields The number of fields of this GeoIndexType
int	size The accumulated size of all 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

Constructors

Constructor and Description
GeoIndexType(String indexTypeName, org.gcube.common.core.scope.GCUBEScope scope) Standard constructor which build a GeoIndexType object from a String containing a GeoIndexType xml document

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsField(String fieldName, GeoIndexField.DataType fieldDataType) A Method to check if this GeoIndexType object contains a certain field
Integer	getFieldPosition(String fieldName) A Method to get the position of a field from the field name
String	toString()

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, wait, wait, wait

Field Detail

fields

public GeoIndexField[] fields

The fields of this GeoIndexType

nrOfFields

public int nrOfFields

The number of fields of this GeoIndexType

size

public int size

The accumulated size of all the fields of this GeoIndexType

Constructor Detail

GeoIndexType

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

Standard constructor which build a GeoIndexType object from a String containing a GeoIndexType xml document

Parameters:

indexTypeName - - The name to assign to the GeoIndexType

indexType - - An xml representation of the indextype

Method Detail

containsField

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

A Method to check if this GeoIndexType 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

getFieldPosition

public Integer getFieldPosition(String fieldName)

A Method to get the position of a field from the field name

Parameters:

fieldName - - The name of the field to get the position of

Returns:

- the position of the specified field. NULL if not found.

toString

public String toString()

Overrides:

toString in class Object