com.esri.gpt.catalog.schema.indexable
Class Indexables

java.lang.Object
  com.esri.gpt.catalog.schema.indexable.Indexables

public class Indexables
extends Object

A collection of indexable properties associated with a metadata schema.

Constructor Summary

Indexables()
Default constructor.

Indexables(Indexables objectToDuplicate)
Construct by duplicating an existing object.

Method Summary

void	addSibling(Indexables sibling) Adds a sibling.
void	configure(CfgContext context, Node node, NamedNodeMap attributes) Configures the object based upon a node loaded from a schema configuration XML.
void	evaluate(Schema schema, IndexableContext context, Document dom, XPath xpath) Evaluates indexable properties based upon the supplied metadata document.
IndexableContext	getIndexableContext() Gets the indexable context.
Namespaces	getNamespaces() Gets the namespaces for XPath evaluation.
List<IndexableProperty>	getProperties() Gets the child properties.
List<Indexables>	getSiblings() Gets the list of associated siblings.
boolean	hasPropertiesOrSiblings() Determines if properties of siblings have been configured for this set.
void	setIndexableContext(IndexableContext context) Sets the indexable context.
void	setNamespaces(Namespaces namespaces) Sets the namespaces for XPath evaluation.
void	setProperties(List<IndexableProperty> properties) Sets the child properties.
void	setSiblings(List<Indexables> siblings) Sets the list of associated siblings.

Methods inherited from class java.lang.Object

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

Constructor Detail

Indexables

public Indexables()

Default constructor.

Indexables

public Indexables(Indexables objectToDuplicate)

Construct by duplicating an existing object.

Parameters:

objectToDuplicate - the object to duplicate

Method Detail

getIndexableContext

public IndexableContext getIndexableContext()

Gets the indexable context.

Returns:

the indexable context

setIndexableContext

public void setIndexableContext(IndexableContext context)

Sets the indexable context.

Parameters:

context - the indexable context

getNamespaces

public Namespaces getNamespaces()

Gets the namespaces for XPath evaluation.

Returns:

the namespaces

setNamespaces

public void setNamespaces(Namespaces namespaces)

Sets the namespaces for XPath evaluation.

Parameters:

namespaces - the namespaces

getProperties

public List<IndexableProperty> getProperties()

Gets the child properties.

Returns:

the child properties

setProperties

public void setProperties(List<IndexableProperty> properties)

Sets the child properties.

Parameters:

properties - the child properties

getSiblings

public List<Indexables> getSiblings()

Gets the list of associated siblings.

Returns:

the siblings

setSiblings

public void setSiblings(List<Indexables> siblings)

Sets the list of associated siblings.

Parameters:

siblings - the siblings

addSibling

public void addSibling(Indexables sibling)

Adds a sibling.

Parameters:

sibling - the sibling to add

configure

public void configure(CfgContext context,
                      Node node,
                      NamedNodeMap attributes)

Configures the object based upon a node loaded from a schema configuration XML.

The following attributes are configured:
fileName

The following child nodes are configured:
namespace property

Parameters:

context - the configuration context

node - the configuration node

attributes - the attributes of the configuration node

evaluate

public void evaluate(Schema schema,
                     IndexableContext context,
                     Document dom,
                     XPath xpath)
              throws XPathExpressionException

Evaluates indexable properties based upon the supplied metadata document.

Parameters:

schema - the schema being evaluated

dom - the metadata document

context - the active indexable context

xpath - an XPath object configured with an appropriate Namespace context for the schema

Throws:

XPathExpressionException - if an evaluation expression fails

hasPropertiesOrSiblings

public boolean hasPropertiesOrSiblings()

Determines if properties of siblings have been configured for this set.

Returns:

true if properties of siblings have been configured