com.esri.gpt.catalog.lucene
Class Storeables

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

All Implemented Interfaces:

IStoreables

public class Storeables
extends Object
implements IStoreables

Essentially defines the storage schema for documents indexed within Lucene.

Field Summary

static String	FIELD_ACL Document access control list field (multi-value) = "acl"
static String	FIELD_DATEMODIFIED Document modification date field name = "datemodified"
static String	FIELD_FID Document file identifier field name = "fileIdentifier"
static String	FIELD_SCHEMA Document SCHEMA = "sys.schema", e.g.
static String	FIELD_SITEUUID Document SITEUUID, parent site uuid = "sys.siteuuid"
static String	FIELD_UUID Document UUID (primary key) field name = "uuid"
static String	FIELD_XML Document XML = "sys.xml"
static String	FIELD_XML_BRIEF CSW Brief Response XML = "sys.xml.brief"
static String	FIELD_XML_SUMMARY CSW Summary Response XML = "sys.xml.brief"

Constructor Summary

Storeables()
Default constructor.

Storeables(PropertyMeanings meanings)
Constructs with a configured collection of property meanings.

Storeables(PropertyMeanings meanings, boolean systemOnly)
Constructs with a configured collection of property meanings.

Method Summary

void	add(IStoreable storable) Adds a store-able property to the collection.
Collection<IStoreable>	collection() Returns the storeables collection (for iteration).
IStoreable	connect(PropertyMeaning meaning) Connects a meaning to a store-able property,
IStoreable	ensure(PropertyMeanings propertyMeanings, String meaningName) Ensures a storeable property within the collection.
IStoreable	get(String name) Finds a store-able property within the collection.

Methods inherited from class java.lang.Object

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

Field Detail

FIELD_ACL

public static final String FIELD_ACL

Document access control list field (multi-value) = "acl"

See Also:

Constant Field Values

FIELD_DATEMODIFIED

public static final String FIELD_DATEMODIFIED

Document modification date field name = "datemodified"

See Also:

Constant Field Values

FIELD_FID

public static final String FIELD_FID

Document file identifier field name = "fileIdentifier"

See Also:

Constant Field Values

FIELD_SCHEMA

public static final String FIELD_SCHEMA

Document SCHEMA = "sys.schema", e.g. http://www.isotc211.org/2005/gmd

See Also:

Constant Field Values

FIELD_SITEUUID

public static final String FIELD_SITEUUID

Document SITEUUID, parent site uuid = "sys.siteuuid"

See Also:

Constant Field Values

FIELD_UUID

public static final String FIELD_UUID

Document UUID (primary key) field name = "uuid"

See Also:

Constant Field Values

FIELD_XML

public static final String FIELD_XML

Document XML = "sys.xml"

See Also:

Constant Field Values

FIELD_XML_BRIEF

public static final String FIELD_XML_BRIEF

CSW Brief Response XML = "sys.xml.brief"

See Also:

Constant Field Values

FIELD_XML_SUMMARY

public static final String FIELD_XML_SUMMARY

CSW Summary Response XML = "sys.xml.brief"

See Also:

Constant Field Values

Constructor Detail

Storeables

public Storeables()

Default constructor.

Storeables

public Storeables(PropertyMeanings meanings)

Constructs with a configured collection of property meanings.

Parameters:

meanings - the configured property meanings

Storeables

public Storeables(PropertyMeanings meanings,
                  boolean systemOnly)

Constructs with a configured collection of property meanings.

Parameters:

meanings - the configured property meanings

systemOnly - if true, only configure the system storeables

Method Detail

add

public void add(IStoreable storable)

Adds a store-able property to the collection.
The collection is keyed on IStoreable.name.

Parameters:

storable - the store-able property to add.

collection

public Collection<IStoreable> collection()

Returns the storeables collection (for iteration).

Returns:

the collection of storeables

connect

public IStoreable connect(PropertyMeaning meaning)

Connects a meaning to a store-able property,

Specified by:

connect in interface IStoreables

Parameters:

meaning - the meaning associated with the property to connect

Returns:

an appropriate store-able (null if none was located);

ensure

public IStoreable ensure(PropertyMeanings propertyMeanings,
                         String meaningName)

Ensures a storeable property within the collection.

Parameters:

propertyMeanings - the configured property meanings

meaningName - the property meaning name

Returns:

the storeable property (null if no match was located)

get

public IStoreable get(String name)

Finds a store-able property within the collection.

Specified by:

get in interface IStoreables

Parameters:

name - the name of the store-able property

Returns:

the store-able property (null if no match was located)