com.endeca.store

Interface Store

All Known Implementing Classes:

InternalStore

public interface Store

The Store is a collection of Node objects. The Store encapsulates a bi-directional tree of nodes with a single root node. This structure enforces a fully connected node tree structures under a single Store. The Store itself has very limited functionality, relying on most tree navigation to be done through the root node itself.

Method Summary

Methods

Modifier and Type	Method and Description
Node	getNode(String path) Retrieves a node based on a path.
String	getPrimaryKeyName() Identifies the property that is used as the 'primary' key for this type of store.
Node	getRootNode() Returns the Root Node.
boolean	nodeExists(String path) Checks to see if a node exists at the given path.

Method Detail

getNode

Node getNode(String path)
             throws PathNotFoundException

Retrieves a node based on a path. If any element of the path given is not found, an exception will be thrown. If the node itself does not exist, but the entire path is valid, the node returned will be NULL.

Note that the paths cannot navigate upwards through the tree. For example,
store.getNode("/node3/node4")
is valid, whereas
store.getNode("/../nodeX/nodeY")
and
store.getNode("/node3/../nodeX")
are not. In such a situation, use the Node#getParent method:
store.getNode("/node1/node2").getParent().getNode("nodeX/nodeY")

This store is intended for INTERNAL USE ONLY. This is not intended for use in custom configuration, data, or cartridge handlers.

Parameters:

path - The path to the desired node.

Returns:

The requested node. NULL if the node itself does not exist.

Throws:

PathNotFoundException - Thrown if any element of the requested path is not valid.

getRootNode

Node getRootNode()

Returns the Root Node. Any Store will only have one Root Node.

Returns:

The root node for this store. The root node should never be NULL.

nodeExists

boolean nodeExists(String path)

Checks to see if a node exists at the given path. Returns FALSE if the node is not found at the requested path. This will not support navigating backwards in a path.

Parameters:

path - The path to the requested node.

Returns:

TRUE if a node exists at the given path. FALSE is any part of the given path does not exist.

getPrimaryKeyName

String getPrimaryKeyName()

Identifies the property that is used as the 'primary' key for this type of store.

Returns:

The name of the primary key property.