org.outerj.daisy.navigation.impl
Class ErrorNode

java.lang.Object
  org.outerj.daisy.navigation.impl.ErrorNode

All Implemented Interfaces:

Node

public class ErrorNode

extends java.lang.Object

implements Node

Field Summary

Fields inherited from interface org.outerj.daisy.navigation.impl.Node

NAVIGATION_NS

Constructor Summary

ErrorNode(java.lang.String message)

Method Summary

boolean	checkId(java.lang.String id) Returns true if the id of this node equals the specified id.
void	generateXml(org.xml.sax.ContentHandler contentHandler, int depth, java.lang.String path, long userId, long[] roleIds) Generates a full, non-contextualized navigation tree up to the specified depth.
void	generateXml(org.xml.sax.ContentHandler contentHandler, Node[] activeNodePath, int pos, boolean contextualized, java.lang.String path, long userId, long[] roleIds)
java.util.List	getExpandedChildList() Returns a list of the child nodes for which the nodes for which isExpandable() returns true are not included, but instead replaced by their children (recursively).
java.lang.String	getId() Returns the id of this node, only works when isIdentifiable() returns true, otherwise throws an UnsupportedOperationException.
boolean	isExpandable() Returns true for expandable nodes, these are nodes which themselves are not a part of the generated navigation tree, but are replaced by one or more other nodes.
boolean	isIdentifiable() Returns true if this node has an ID and will generate a corresponding node in the output tree.
boolean	isVisible(long userId, long[] roleIds) Returns true if this node or any of its chilren would produce a visible node in the generated navigation tree.
void	populateNodeLookupMap(java.util.Map map, java.lang.String path) Nodes representing documents should add themselves to the map, using as key a VariantKey object and as value a String object representing the navigation tree path.
java.util.List	searchDocument(org.outerj.daisy.repository.VariantKey document)
void	searchPath(java.lang.String[] path, int pos, Node[] foundPath)

Methods inherited from class java.lang.Object

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

Constructor Detail

ErrorNode

public ErrorNode(java.lang.String message)

Method Detail

searchPath

public void searchPath(java.lang.String[] path,
                       int pos,
                       Node[] foundPath)
                throws org.outerj.daisy.repository.RepositoryException

Specified by:

searchPath in interface Node

Parameters:

path - the path we're looking for, each array element contains an id

pos - the current position in the array

foundPath - as the corresponding path nodes are found, they should be assigned in this array. This array has (of course) the same length as the 'path' array.

Throws:

org.outerj.daisy.repository.RepositoryException

searchDocument

public java.util.List searchDocument(org.outerj.daisy.repository.VariantKey document)
                              throws org.outerj.daisy.repository.RepositoryException

Specified by:

searchDocument in interface Node

Throws:

org.outerj.daisy.repository.RepositoryException

populateNodeLookupMap

public void populateNodeLookupMap(java.util.Map map,
                                  java.lang.String path)
                           throws org.outerj.daisy.repository.RepositoryException

Description copied from interface: Node

Nodes representing documents should add themselves to the map, using as key a VariantKey object and as value a String object representing the navigation tree path. A node should not add itself to the map if there is already another mapping for its document ID in the map.

Specified by:

populateNodeLookupMap in interface Node

Throws:

org.outerj.daisy.repository.RepositoryException

checkId

public boolean checkId(java.lang.String id)

Description copied from interface: Node

Returns true if the id of this node equals the specified id.

Specified by:

checkId in interface Node

isExpandable

public boolean isExpandable()
                     throws org.outerj.daisy.repository.RepositoryException

Description copied from interface: Node

Returns true for expandable nodes, these are nodes which themselves are not a part of the generated navigation tree, but are replaced by one or more other nodes.

Specified by:

isExpandable in interface Node

Throws:

org.outerj.daisy.repository.RepositoryException

getExpandedChildList

public java.util.List getExpandedChildList()
                                    throws org.outerj.daisy.repository.RepositoryException

Description copied from interface: Node

Returns a list of the child nodes for which the nodes for which Node.isExpandable() returns true are not included, but instead replaced by their children (recursively).

Specified by:

getExpandedChildList in interface Node

Throws:

org.outerj.daisy.repository.RepositoryException

generateXml

public void generateXml(org.xml.sax.ContentHandler contentHandler,
                        Node[] activeNodePath,
                        int pos,
                        boolean contextualized,
                        java.lang.String path,
                        long userId,
                        long[] roleIds)
                 throws org.outerj.daisy.repository.RepositoryException,
                        org.xml.sax.SAXException

Specified by:

generateXml in interface Node

Throws:

org.outerj.daisy.repository.RepositoryException

org.xml.sax.SAXException

generateXml

public void generateXml(org.xml.sax.ContentHandler contentHandler,
                        int depth,
                        java.lang.String path,
                        long userId,
                        long[] roleIds)
                 throws org.outerj.daisy.repository.RepositoryException,
                        org.xml.sax.SAXException

Description copied from interface: Node

Generates a full, non-contextualized navigation tree up to the specified depth. Specify a depth of -1 to get the full tree.

Specified by:

generateXml in interface Node

Throws:

org.outerj.daisy.repository.RepositoryException

org.xml.sax.SAXException

isIdentifiable

public boolean isIdentifiable()

Description copied from interface: Node

Returns true if this node has an ID and will generate a corresponding node in the output tree.

Specified by:

isIdentifiable in interface Node

getId

public java.lang.String getId()

Description copied from interface: Node

Returns the id of this node, only works when Node.isIdentifiable() returns true, otherwise throws an UnsupportedOperationException.

Specified by:

getId in interface Node

isVisible

public boolean isVisible(long userId,
                         long[] roleIds)
                  throws org.outerj.daisy.repository.RepositoryException

Description copied from interface: Node

Returns true if this node or any of its chilren would produce a visible node in the generated navigation tree.

Specified by:

isVisible in interface Node

Throws:

org.outerj.daisy.repository.RepositoryException