com.esri.gpt.catalog.lucene
Class Storeable

java.lang.Object
  com.esri.gpt.catalog.lucene.Storeable

All Implemented Interfaces:

IStoreable

Direct Known Subclasses:

AclProperty, AnyTextProperty, GeometryProperty

public class Storeable
extends Object
implements IStoreable

Represents a data store property associated with a document.

A storable property can have multiple associated fields, for instance a GeometryProperty has 5 field fields:
geometry.minx geometry.minx geometry.maxx geometry.maxy geometry.area

Constructor Summary

Storeable(String name)
Constructs with a supplied name.

Method Summary

protected void	appendForWrite(Document document) Appends underlying fields to a document prior to writing the document to the index.
void	appendForWrite(Document document, Object value) Appends underlying fields to a document prior to writing the document to the index.
DatastoreField	getComparisonField() Gets the non-tokenized field for exact/range comparison queries.
DatastoreFields	getFields() Gets the underlying data store fields associated with the property.
String	getName() Gets the property name.
DatastoreField	getRetrievalField() Gets the field used to retrieve data from the store.
DatastoreField	getTermsField() Gets the tokenized field for term based queries.
Object[]	getValues() Gets the underlying values to store.
void	setComparisonField(DatastoreField field) Sets the non-tokenized field for exact/range comparison queries.
void	setRetrievalField(DatastoreField field) Sets the field used to retrieve data from the store.
void	setTermsField(DatastoreField field) Sets the tokenized field for term based queries.
void	setValue(Object value) Sets the value collection to a single object value.
void	setValues(Object[] values) Sets the underlying values to store.

Methods inherited from class java.lang.Object

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

Constructor Detail

Storeable

public Storeable(String name)

Constructs with a supplied name.

Parameters:

name - the property name

Method Detail

getComparisonField

public DatastoreField getComparisonField()

Gets the non-tokenized field for exact/range comparison queries.

Returns:

the comparison field

setComparisonField

public void setComparisonField(DatastoreField field)

Sets the non-tokenized field for exact/range comparison queries.

Parameters:

field - the comparison field

getRetrievalField

public DatastoreField getRetrievalField()

Gets the field used to retrieve data from the store.

Returns:

the retrieval field

setRetrievalField

public void setRetrievalField(DatastoreField field)

Sets the field used to retrieve data from the store.

Parameters:

field - the retrieval field

getFields

public DatastoreFields getFields()

Gets the underlying data store fields associated with the property.

Returns:

the data store fields.

getName

public String getName()

Gets the property name.

Specified by:

getName in interface IStoreable

Returns:

the property name

getTermsField

public DatastoreField getTermsField()

Gets the tokenized field for term based queries.

Returns:

the terms field

setTermsField

public void setTermsField(DatastoreField field)

Sets the tokenized field for term based queries.

Parameters:

field - the terms field

getValues

public Object[] getValues()

Gets the underlying values to store.

The values array wild be null if the field was not populated within the associated document.

There can be multiple values associated with a field, keywords for instance.

Specified by:

getValues in interface IStoreable

Returns:

the data values to store

setValue

public void setValue(Object value)

Sets the value collection to a single object value.

Specified by:

setValue in interface IStoreable

Parameters:

value - the object value to set

setValues

public void setValues(Object[] values)

Sets the underlying values to store.

The values array wild be null if the field was not populated within the associated document.

There can be multiple values associated with a field, keywords for instance.

Specified by:

setValues in interface IStoreable

Parameters:

values - the data values to store

appendForWrite

protected void appendForWrite(Document document)

Appends underlying fields to a document prior to writing the document to the index.

Parameters:

document - the Lucene document

appendForWrite

public void appendForWrite(Document document,
                           Object value)

Appends underlying fields to a document prior to writing the document to the index.

Parameters:

document - the Lucene document

value - the input value to write