org.gcube.indexmanagement.common

Class ForwardIndexField

java.lang.Object

org.gcube.indexmanagement.common.ForwardIndexField

public class ForwardIndexField
extends Object

Represent the characteristics of a single field in a forward index RowSet.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ForwardIndexField.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
ForwardIndexField.DataType	dataType The data type of the field
String	dataTypeFormat The format of the data type (if applicable)
String	name The name of the field
int	size The size of the field

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
ForwardIndexField.DataType	getDataType() Returns the data type in use
String	getDataTypeFormat() Returns the format of the data type in use
String	getName() Returns the field name
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

size

public int size

The size of the field

dataType

public ForwardIndexField.DataType dataType

The data type of the field

dataTypeFormat

public String dataTypeFormat

The format of the data type (if applicable)

Constructor Detail

ForwardIndexField

public ForwardIndexField()

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

ForwardIndexField

public ForwardIndexField(String name,
                 ForwardIndexField.DataType dataType)

Constructor setting all field attributes.

Parameters:

name - - The name of the field to be created

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

ForwardIndexField

public ForwardIndexField(String name,
                 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

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

Method Detail

getName

public String getName()

Returns the field name

Returns:

the field name

getDataType

public ForwardIndexField.DataType getDataType()

Returns the data type in use

Returns:

the data type

getDataTypeFormat

public String getDataTypeFormat()

Returns the format of the data type in use

Returns:

the data type format

toString

public String toString()

Overrides:

toString in class Object