org.gcube.indexmanagement.geo

Class GeoIndexField

java.lang.Object

org.gcube.indexmanagement.geo.GeoIndexField

public class GeoIndexField
extends Object

Represent the characteristics of a single field in a RowSet.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GeoIndexField.DataType An enumeration of accepted data types, along with their respective Class objects and default byte size

Field Summary

Fields

Modifier and Type	Field and Description
GeoIndexField.DataType	dataType The data type of the field
boolean	isReturnable An indicator of whether the field is returnable (to be returned from a query)
boolean	isVariable An indicator of whether the size of this field is variable, and we can NOT store it directly to the R-tree of geo-tools
String	name The name of the field
int	size The byte size of the field

Constructor Summary

Constructors

Constructor and Description
GeoIndexField() Empty constructor.
GeoIndexField(String name, boolean isReturnable, GeoIndexField.DataType dataType) Constructor setting all field attributes.
GeoIndexField(String name, boolean isReturnable, int stringDataTypeSize) Constructor setting all field attributes.

Method Summary

Methods

Modifier and Type	Method and Description
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

name

public String name

The name of the field

isVariable

public boolean isVariable

An indicator of whether the size of this field is variable, and we can NOT store it directly to the R-tree of geo-tools

isReturnable

public boolean isReturnable

An indicator of whether the field is returnable (to be returned from a query)

size

public int size

The byte size of the field

dataType

public GeoIndexField.DataType dataType

The data type of the field

Constructor Detail

GeoIndexField

public GeoIndexField()

Empty constructor. The field attributes must be set in subsequent calls.

GeoIndexField

public GeoIndexField(String name,
             boolean isReturnable,
             GeoIndexField.DataType dataType)

Constructor setting all field attributes.

Parameters:

name - - The name of the field to be created

isReturnable - - An indicator of whether the field to be created is returnable (form a query)

dataType - - The data type of the field to be created

GeoIndexField

public GeoIndexField(String name,
             boolean isReturnable,
             int stringDataTypeSize)

Constructor setting all field attributes. Sets the data type to DataType.STRING with the specified byte size.

Parameters:

name - - The name of the field to be created

isReturnable - - An indicator of whether the field to be created is returnable (form a query)

stringDataTypeSize - - The byte size of the field to be created

Method Detail

toString

public String toString()

Overrides:

toString in class Object