|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SiteTreeNode
This interface is a wrapper around the more general w3c.Node which hides some details which are irrelevant for site tree nodes. It basically delegates everything to the Node.
Method Summary | |
---|---|
void |
accept(SiteTreeNodeVisitor visitor)
Call the visit method of the visitor, that mean the operation that shall be perfoemed on this node (Visitor pattern) |
void |
acceptReverseSubtree(SiteTreeNodeVisitor visitor)
Traverse in a reverse way the node ant its children and call the accept method. |
void |
acceptSubtree(SiteTreeNodeVisitor visitor)
Traverse the node ant its children and call the accept method. |
void |
addLabel(Label label)
Add a label to this node iff the node does not have this label already. |
void |
deleteChildren()
Remove the children of this node. |
java.lang.String |
getAbsoluteId()
Get the absolute id of this node. |
java.lang.String |
getAbsoluteParentId()
Get the absolute parent-id of this node. |
SiteTreeNode[] |
getChildren()
Get the sitetreenodes, which are children of this node |
SiteTreeNode[] |
getChildren(java.lang.String language)
Get the sitetreenodes, which are children of this node and contain a label for the given language. |
java.lang.String |
getHref()
Deprecated. use the href attribute of the label instead |
java.lang.String |
getId()
Get the id of this node. |
Label |
getLabel(java.lang.String xmlLanguage)
Get the label for a specific language. |
Label[] |
getLabels()
Get all labels for this node (independent of their language attribute). |
java.lang.String |
getNextSiblingDocumentId()
|
SiteTreeNode[] |
getNextSiblings()
Get the sitetreenodes, which are the siblings following this node |
SiteTreeNode |
getParent()
Returns the parent node of this node. |
SiteTreeNode |
getParent(java.lang.String language)
Returns the parent node of this node or null if the parent has no label for the given language. |
java.lang.String |
getParentId()
Get the parent-id of this node. |
java.lang.String |
getSuffix()
Get the suffix of this node. |
boolean |
hasLink()
Check whether this node has a link. |
java.util.List |
postOrder()
Give a list of the children and this node in a post order way |
java.util.List |
preOrder()
Give a list of the children and this node in a pre order way |
SiteTreeNode[] |
removeChildren()
Deprecated. Use deleteChildren() instead |
void |
removeLabel(Label label)
Remove a label from this node. |
void |
setLabel(Label label)
Sets a label of an this node. |
void |
setNodeAttribute(java.lang.String attributeName,
java.lang.String attributeValue)
Sets an attribute of this node. |
boolean |
visibleInNav()
Check whether this node is visible in the navigation |
Method Detail |
---|
java.lang.String getParentId()
SiteTreeNode getParent()
SiteTreeNode getParent(java.lang.String language)
language
- A language string.
java.lang.String getAbsoluteId()
java.lang.String getAbsoluteParentId()
java.lang.String getId()
Label[] getLabels()
Array
of labels.Label getLabel(java.lang.String xmlLanguage)
xmlLanguage
- the language for which the label is requested.
Label
if there is one for the given language,
null otherwise.void addLabel(Label label)
label
- the label to be added.void removeLabel(Label label)
label
- the label to be removed.boolean visibleInNav()
java.lang.String getHref()
java.lang.String getSuffix()
boolean hasLink()
SiteTreeNode[] getChildren()
SiteTreeNode[] getChildren(java.lang.String language)
language
- A language string.
SiteTreeNode[] removeChildren()
void deleteChildren() throws SiteTreeException
SiteTreeException
SiteTreeNode[] getNextSiblings()
java.lang.String getNextSiblingDocumentId()
void accept(SiteTreeNodeVisitor visitor) throws DocumentException
visitor
- The visitor.
DocumentException
- if an error occursvoid acceptSubtree(SiteTreeNodeVisitor visitor) throws DocumentException
visitor
- The visitor.
DocumentException
- if an error occursvoid acceptReverseSubtree(SiteTreeNodeVisitor visitor) throws DocumentException
visitor
- The visitor.
DocumentException
- if an error occursvoid setLabel(Label label)
label
- the label to addvoid setNodeAttribute(java.lang.String attributeName, java.lang.String attributeValue)
attributeName
- name of the attributeattributeValue
- the value of the respective attributejava.util.List preOrder()
java.util.List postOrder()
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |