|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.outerj.daisy.navigation.impl.RootNode
public class RootNode
Field Summary |
---|
Fields inherited from interface org.outerj.daisy.navigation.impl.Node |
---|
NAVIGATION_NS |
Constructor Summary | |
---|---|
RootNode(Node delegate)
|
Method Summary | |
---|---|
boolean |
checkId(java.lang.String id,
long branchId,
long languageId)
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 includeOnlyActivePath,
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 Node.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 Node.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[] roleId,
Node[] activeNodePath,
int activeNodePathPos)
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 key)
|
void |
searchPath(java.lang.String[] path,
int pos,
long branchId,
long languageId,
Node[] foundPath)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public RootNode(Node delegate)
Method Detail |
---|
public void searchPath(java.lang.String[] path, int pos, long branchId, long languageId, Node[] foundPath) throws org.outerj.daisy.repository.RepositoryException
searchPath
in interface Node
path
- the path we're looking for, each array element contains an idpos
- the current position in the arrayfoundPath
- as the corresponding path nodes are found, they should be assigned
org.outerj.daisy.repository.RepositoryException
public java.util.List searchDocument(org.outerj.daisy.repository.VariantKey key) throws org.outerj.daisy.repository.RepositoryException
searchDocument
in interface Node
org.outerj.daisy.repository.RepositoryException
public void populateNodeLookupMap(java.util.Map map, java.lang.String path) throws org.outerj.daisy.repository.RepositoryException
Node
populateNodeLookupMap
in interface Node
org.outerj.daisy.repository.RepositoryException
public boolean checkId(java.lang.String id, long branchId, long languageId) throws org.outerj.daisy.repository.RepositoryException
Node
checkId
in interface Node
org.outerj.daisy.repository.RepositoryException
public boolean isExpandable() throws org.outerj.daisy.repository.RepositoryException
Node
isExpandable
in interface Node
org.outerj.daisy.repository.RepositoryException
public java.util.List getExpandedChildList() throws org.outerj.daisy.repository.RepositoryException
Node
Node.isExpandable()
returns true are not included, but instead
replaced by their children (recursively). This includes both
visible and non-visible nodes.
getExpandedChildList
in interface Node
org.outerj.daisy.repository.RepositoryException
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
Node
generateXml
in interface Node
org.outerj.daisy.repository.RepositoryException
org.xml.sax.SAXException
public void generateXml(org.xml.sax.ContentHandler contentHandler, Node[] activeNodePath, int pos, boolean includeOnlyActivePath, java.lang.String path, long userId, long[] roleIds) throws org.outerj.daisy.repository.RepositoryException, org.xml.sax.SAXException
generateXml
in interface Node
org.outerj.daisy.repository.RepositoryException
org.xml.sax.SAXException
public boolean isIdentifiable()
Node
isIdentifiable
in interface Node
public java.lang.String getId()
Node
Node.isIdentifiable()
returns true,
otherwise throws an UnsupportedOperationException.
getId
in interface Node
public boolean isVisible(long userId, long[] roleId, Node[] activeNodePath, int activeNodePathPos) throws org.outerj.daisy.navigation.NavigationException
Node
isVisible
in interface Node
activeNodePath
- this parameter can be null (if there is not active node path)
org.outerj.daisy.navigation.NavigationException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |