|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Node
Field Summary | |
---|---|
static java.lang.String |
NAVIGATION_NS
|
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 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,
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 document)
|
void |
searchPath(java.lang.String[] path,
int pos,
long branchId,
long languageId,
Node[] foundPath)
|
Field Detail |
---|
static final java.lang.String NAVIGATION_NS
Method Detail |
---|
void searchPath(java.lang.String[] path, int pos, long branchId, long languageId, Node[] foundPath) throws org.outerj.daisy.repository.RepositoryException
path
- the path we're looking for, each array element contains an idpos
- the current position in the arraybranchId
- languageId
- foundPath
- as the corresponding path nodes are found, they should be assigned
org.outerj.daisy.repository.RepositoryException
java.util.List searchDocument(org.outerj.daisy.repository.VariantKey document) throws org.outerj.daisy.repository.RepositoryException
org.outerj.daisy.repository.RepositoryException
void populateNodeLookupMap(java.util.Map map, java.lang.String path) throws org.outerj.daisy.repository.RepositoryException
org.outerj.daisy.repository.RepositoryException
boolean checkId(java.lang.String id, long branchId, long languageId) throws org.outerj.daisy.repository.RepositoryException
org.outerj.daisy.repository.RepositoryException
boolean isExpandable() throws org.outerj.daisy.repository.RepositoryException
org.outerj.daisy.repository.RepositoryException
java.util.List getExpandedChildList() throws org.outerj.daisy.repository.RepositoryException
isExpandable()
returns true are not included, but instead
replaced by their children (recursively). This includes both
visible and non-visible nodes.
org.outerj.daisy.repository.RepositoryException
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
org.outerj.daisy.repository.RepositoryException
org.xml.sax.SAXException
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
org.outerj.daisy.repository.RepositoryException
org.xml.sax.SAXException
boolean isIdentifiable() throws org.outerj.daisy.repository.RepositoryException
org.outerj.daisy.repository.RepositoryException
java.lang.String getId() throws org.outerj.daisy.repository.RepositoryException
isIdentifiable()
returns true,
otherwise throws an UnsupportedOperationException.
org.outerj.daisy.repository.RepositoryException
boolean isVisible(long userId, long[] roleIds, Node[] activeNodePath, int activeNodePathPos) throws org.outerj.daisy.repository.RepositoryException
activeNodePath
- this parameter can be null (if there is not active node path)
org.outerj.daisy.repository.RepositoryException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |