com.endeca.store.configuration

Class InternalStore

java.lang.Object

com.endeca.store.configuration.InternalStore

All Implemented Interfaces:

Store

public class InternalStore
extends Object
implements Store

Basic Store implementation used throughout all actors on Content and Configuration in the Endeca Tool and Frameworks. This store represents any content, configuration, and data that may be stored within the Tools or Assembler API.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PRIMARY_KEY_NAME

Constructor Summary

Constructors

Constructor and Description
InternalStore() Used to initialize the store.

Method Summary

Methods

Modifier and Type	Method and Description
Node	createPath(String absPath)
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.

Methods inherited from class java.lang.Object

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

Field Detail

PRIMARY_KEY_NAME

public static final String PRIMARY_KEY_NAME

See Also:

Constant Field Values

Constructor Detail

InternalStore

public InternalStore()

Used to initialize the store.

Method Detail

getNode

public Node getNode(String path)
             throws PathNotFoundException

Description copied from interface: Store

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.

Specified by:

getNode in interface Store

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

public Node getRootNode()

Description copied from interface: Store

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

Specified by:

getRootNode in interface Store

Returns:

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

nodeExists

public boolean nodeExists(String path)

Description copied from interface: Store

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.

Specified by:

nodeExists in interface Store

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.

createPath

public Node createPath(String absPath)
                throws BadPathException,
                       PathNotFoundException

Throws:

BadPathException

PathNotFoundException

getPrimaryKeyName

public String getPrimaryKeyName()

Description copied from interface: Store

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

Specified by:

getPrimaryKeyName in interface Store

Returns:

The name of the primary key property.