|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SiteTree
Field Summary | |
---|---|
static java.lang.String |
NAMESPACE_URI
|
Method Summary | |
---|---|
void |
addLabel(java.lang.String documentId,
Label label)
Add a label to an existing node |
void |
addNode(SiteTreeNode node)
Add a node. |
void |
addNode(SiteTreeNode node,
java.lang.String refDocumentId)
Add a node. |
void |
addNode(java.lang.String documentid,
Label[] labels,
boolean visibleInNav,
java.lang.String href,
java.lang.String suffix,
boolean link)
Add a node. |
void |
addNode(java.lang.String documentid,
Label[] labels,
boolean visibleInNav,
java.lang.String href,
java.lang.String suffix,
boolean link,
java.lang.String refDocumentId)
Insert a node before a given node Compute the parent id and the id of the node from the document-id |
void |
addNode(java.lang.String parentid,
java.lang.String id,
Label[] labels,
boolean visibleInNav)
Add a node. |
void |
addNode(java.lang.String parentid,
java.lang.String id,
Label[] labels,
boolean visibleInNav,
java.lang.String href,
java.lang.String suffix,
boolean link)
Add a node. |
void |
addNode(java.lang.String parentid,
java.lang.String id,
Label[] labels,
boolean visibleInNav,
java.lang.String href,
java.lang.String suffix,
boolean link,
java.lang.String refDocumentId)
Insert a node before a given node |
void |
copy(SiteTreeNode src,
SiteTreeNode dst,
java.lang.String newId,
java.lang.String followingSibling)
Copy a node with all its child node. |
void |
deleteNode(java.lang.String documentId)
Removes the node corresponding to the given document-id from the tree. |
SiteTreeNode |
getNode(java.lang.String documentId)
Return the Node for a given document-id. |
SiteTreeNode[] |
getTopNodes()
Return the top level nodes in the sitetree. |
void |
importSubtree(SiteTreeNode subtreeRoot,
SiteTreeNode newParent,
java.lang.String newid,
java.lang.String refDocumentId)
Deprecated. Use copy, move instead. |
void |
move(SiteTreeNode src,
SiteTreeNode dst,
java.lang.String newId,
java.lang.String followingSibling)
Move a node with all its child node. |
void |
moveDown(java.lang.String documentid)
Move down the node amongst its siblings. |
void |
moveUp(java.lang.String documentid)
Move up the node amongst its siblings. |
void |
removeLabel(java.lang.String documentId,
Label label)
Remove a label from a node |
SiteTreeNode |
removeNode(java.lang.String documentId)
Deprecated. Use deleteNode() instead |
void |
save()
Save the SiteTree. |
void |
setLabel(java.lang.String documentId,
Label label)
Sets a label of an existing node. |
Field Detail |
---|
static final java.lang.String NAMESPACE_URI
Method Detail |
---|
void addNode(java.lang.String parentid, java.lang.String id, Label[] labels, boolean visibleInNav) throws SiteTreeException
parentid
- where the node is to be addedid
- e.g. "concepts"labels
- the labels of the node that is to be added
SiteTreeException
- if the addition failedvoid addNode(java.lang.String parentid, java.lang.String id, Label[] labels, boolean visibleInNav, java.lang.String href, java.lang.String suffix, boolean link) throws SiteTreeException
parentid
- the node where the new node is to be insertedid
- the node idlabels
- the labelsvisibleInNav
- the visibility of a node in the navigation. It is meant to hide specific nodes within the "public" navigation whereas the node is visible within the info/site area.href
- the href of the new node (internal and external references)suffix
- the suffix of the new nodelink
- Visibility of link respectively href. It is meant to support "grouping" nodes in the navigation which do not relate to a document (internal) or external link (www).
SiteTreeException
- if the addition failedvoid addNode(java.lang.String parentid, java.lang.String id, Label[] labels, boolean visibleInNav, java.lang.String href, java.lang.String suffix, boolean link, java.lang.String refDocumentId) throws SiteTreeException
parentid
- the node where the new node is to be insertedid
- the node idlabels
- the labelsvisibleInNav
- the visibility of a node in the navigationhref
- the href of the new nodesuffix
- the suffix of the new nodelink
- the linkrefDocumentId
- document-id of the node, before which the new node will be inserted.
SiteTreeException
- if the addition failedvoid addNode(java.lang.String documentid, Label[] labels, boolean visibleInNav, java.lang.String href, java.lang.String suffix, boolean link) throws SiteTreeException
documentid
- the document-id of the new node.
From this the parent-id and the id are computedlabels
- the labelshref
- the hrefsuffix
- the suffixlink
- the link
SiteTreeException
- if the addition failedvoid addNode(java.lang.String documentid, Label[] labels, boolean visibleInNav, java.lang.String href, java.lang.String suffix, boolean link, java.lang.String refDocumentId) throws SiteTreeException
documentid
- the document-id of the new node.
From this the parent-id and the id are computedlabels
- the labelshref
- the hrefsuffix
- the suffixlink
- the linkrefDocumentId
- document-id of the node, before which the new node will be inserted.
SiteTreeException
- if the addition failedvoid addNode(SiteTreeNode node) throws SiteTreeException
node
- the SiteTreeNode
that is to be added
SiteTreeException
- if the addition failedvoid addNode(SiteTreeNode node, java.lang.String refDocumentId) throws SiteTreeException
node
- the SiteTreeNode
that is to be addedrefDocumentId
- document-id of the node, before which the new node will be inserted.
SiteTreeException
- if the addition failedvoid addLabel(java.lang.String documentId, Label label)
documentId
- the document-id to which the label is to be added.label
- the label to addvoid setLabel(java.lang.String documentId, Label label)
documentId
- the document-id to which the label is to be added.label
- the label to addvoid removeLabel(java.lang.String documentId, Label label)
documentId
- the document-id from which the label is to be removed.label
- the label to removeSiteTreeNode removeNode(java.lang.String documentId)
documentId
- the document-id of the node that is to be removed
void deleteNode(java.lang.String documentId) throws SiteTreeException
documentId
- the document-id of the node that is to be removed
SiteTreeException
SiteTreeNode getNode(java.lang.String documentId)
documentId
- the document-id of the node that is requested
SiteTreeNode
if there is a node for the given
document-id, null otherwise.SiteTreeNode[] getTopNodes()
void moveUp(java.lang.String documentid) throws SiteTreeException
documentid
- The document id of the node.
SiteTreeException
- if the moving failed.void moveDown(java.lang.String documentid) throws SiteTreeException
documentid
- The document id of the node.
SiteTreeException
- if the moving failed.void copy(SiteTreeNode src, SiteTreeNode dst, java.lang.String newId, java.lang.String followingSibling) throws SiteTreeException
src
- Node to copy.dst
- Parent node where node will be inserted.newId
- The new id of the inserted node (in case when the node id exists already).followingSibling
- The sibling node that should follow this node (ordering),
if null the node will be inserted at the end.
SiteTreeException
void move(SiteTreeNode src, SiteTreeNode dst, java.lang.String newId, java.lang.String followingSibling) throws SiteTreeException
src
- Node to move.dst
- Parent node where node will be inserted.newId
- The new id of the inserted node (in case when the node id exists already).followingSibling
- The sibling node that should follow the moved node (ordering),
if null the node will be inserted at the end.
SiteTreeException
void importSubtree(SiteTreeNode subtreeRoot, SiteTreeNode newParent, java.lang.String newid, java.lang.String refDocumentId) throws SiteTreeException
subtreeRoot
- The root of the subtree to import.newParent
- The node where the subtree shall be inserted.newid
- The new id of the inserted subtreeRoot node (to not overwriterefDocumentId
- The document-id corresponding to the reference node, before which
the subtree should be inserted. If null, the subtree is inserted at the end.
in case there is already a node with the same id in the tree).
SiteTreeException
- when an error occurs.void save() throws SiteTreeException
SiteTreeException
- if the saving failed
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |