Interface TemplateNode
-
- All Superinterfaces:
Serializable
- All Known Subinterfaces:
WritableTemplateNode
public interface TemplateNode extends Serializable
A template node represents a template and provides direct access to the corresponding child templates. In this way it allows to have the complete hierarchy of a (parent) template, aka. a template tree. A template tree is read-only, useWritableTemplateNode
to build a template tree.
It also provides the data elements of the template allowing to list the current data values of the corresponding instances.
-
-
Field Summary
Fields Modifier and Type Field Description static long
serialVersionUID
Generated ID for serialisation.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Map<Integer,TemplateNode>
getChildren()
Gets the direct children of the template this template node refers to as template nodes (thus the template node hierarchy) indexed by the ID of the node in this template.Collection<DataElement>
getDataElements()
Gets the data elements of the template this template node refers to.int
getNodeId()
Gets the node ID of the parent node of the template this template node refers to.TemplateReference
getTemplate()
Gets the template (reference) this template node refers to.
-
-
-
Field Detail
-
serialVersionUID
static final long serialVersionUID
Generated ID for serialisation.- See Also:
- Constant Field Values
-
-
Method Detail
-
getChildren
Map<Integer,TemplateNode> getChildren()
Gets the direct children of the template this template node refers to as template nodes (thus the template node hierarchy) indexed by the ID of the node in this template.- Returns:
- The direct children of the template this template node refers to as template nodes (thus the template node hierarchy) indexed by the ID of the node in this template.
-
getNodeId
int getNodeId()
Gets the node ID of the parent node of the template this template node refers to. This will beInteger.MIN_VALUE
in case of a top-level template.- Returns:
- The node ID of the parent node of the template this template node refers to or
Integer.MIN_VALUE
in case this is a top-level template.
-
getTemplate
TemplateReference getTemplate()
Gets the template (reference) this template node refers to.- Returns:
- The template (reference) this template node refers to.
-
getDataElements
Collection<DataElement> getDataElements()
Gets the data elements of the template this template node refers to.- Returns:
- The data elements of the template this template node refers to.
-
-