java.lang.Object

org.javarosa.core.model.instance.TreeElement

All Implemented Interfaces:: AbstractTreeElement<TreeElement>, Externalizable

public class TreeElement
extends Object
implements Externalizable, AbstractTreeElement<TreeElement>

An element of a FormInstance.

TreeElements represent an XML node in the instance. It may either have a value (e.g., Drew), a number of TreeElement children (e.g., ), or neither (e.g.,)

TreeElements can also represent attributes. Attributes are unique from normal elements in that they are not "children" of their parent, and are always leaf nodes: IE cannot have children.

TODO: Split out the bind-able session data from this class and leave only the mandatory values to speed up new DOM-like models

Author:: Clayton Sims

Field Summary

Fields

Modifier and Type Field Description

protected int dataType

protected int multiplicity

Constructor Summary

Constructors
Constructor	Description
`TreeElement()`	TreeElement with null name and 0 multiplicity? (a "hidden root" node?)
`TreeElement(String name)`
`TreeElement(String name, int multiplicity)`

Method Summary

Modifier and Type	Method	Description
`void`	`accept(ITreeVisitor visitor)`	Visitor pattern acceptance method.
`void`	`addChild(TreeElement child)`
`void`	`alertStateObservers(int changeFlags)`
`static TreeReference`	`BuildRef(AbstractTreeElement elem)`
`static int`	`CalculateDepth(AbstractTreeElement elem)`
`void`	`clearCaches()`
`void`	`clearChildrenCaches()`
`static TreeElement`	`constructAttributeElement(String namespace, String name, String value)`	Construct a TreeElement which represents an attribute with the provided namespace and name.
`TreeElement`	`deepCopy(boolean includeTemplates)`
`TreeElement`	`getAttribute(String namespace, String name)`	Retrieves the TreeElement representing the attribute at the provided namespace and name, or null if none exists.
`static TreeElement`	`getAttribute(List<TreeElement> attributes, String namespace, String name)`	Retrieves the TreeElement representing the attribute for the provided namespace and name, or null if none exists.
`int`	`getAttributeCount()`	Returns the number of attributes of this element.
`String`	`getAttributeName(int index)`	get name of attribute at 'index' in the list
`String`	`getAttributeNamespace(int index)`	get namespace of attribute at 'index' in the list
`String`	`getAttributeValue()`
`String`	`getAttributeValue(int index)`	get value of attribute at 'index' in the list
`String`	`getAttributeValue(String namespace, String name)`	get value of attribute with namespace:name' in the list
`TreeElement`	`getBindAttribute(String namespace, String name)`	Retrieves the TreeElement representing an arbitrary bind attribute for this element at the provided namespace and name, or null if none exists.
`List<TreeElement>`	`getBindAttributes()`
`String`	`getBindAttributeValue(String namespace, String name)`	Returns the value of the given bind attribute from the given namespace.
`TreeElement`	`getChild(String name, int multiplicity)`
`TreeElement`	`getChildAt(int i)`
`int`	`getChildMultiplicity(String name)`
`List<TreeElement>`	`getChildrenWithName(String name)`	Get all the child nodes of this element, with specific name
`Constraint`	`getConstraint()`
`int`	`getDataType()`
`int`	`getDepth()`
`String`	`getInstanceName()`
`int`	`getMult()`
`int`	`getMultiplicity()`
`String`	`getName()`
`String`	`getNamespace()`
`String`	`getNamespacePrefix()`
`int`	`getNumChildren()`
`AbstractTreeElement`	`getParent()`
`String`	`getPreloadHandler()`
`String`	`getPreloadParams()`
`TreeReference`	`getRef()`
`IAnswerData`	`getValue()`
`boolean`	`hasChildren()`
`boolean`	`isAttribute()`
`boolean`	`isChildable()`
`boolean`	`isEnabled()`
`boolean`	`isLeaf()`
`boolean`	`isRelevant()`
`boolean`	`isRepeatable()`
`boolean`	`isRequired()`
`void`	`populate(TreeElement incoming, FormDef f)`
`void`	`populateTemplate(TreeElement incoming, FormDef f)`
`void`	`readExternal(DataInputStream in, PrototypeFactory pf)`
`void`	`registerStateObserver(FormElementStateListener qsl)`
`void`	`removeChild(String name, int multiplicity)`
`void`	`removeChild(TreeElement child)`
`void`	`removeChildAt(int i)`
`void`	`removeChildren(String name)`
`boolean`	`setAnswer(IAnswerData answer)`
`void`	`setAttribute(String namespace, String name, String value)`
`static void`	`setAttribute(TreeElement parent, List<TreeElement> attrs, String namespace, String name, String value)`
`void`	`setBindAttribute(String namespace, String name, String value)`
`void`	`setBindAttributes(List<TreeElement> bindAttributes)`
`void`	`setConstraint(Constraint constraint)`
`void`	`setDataType(int dataType)`
`void`	`setEnabled(boolean enabled)`
`void`	`setEnabled(boolean enabled, boolean inherited)`
`void`	`setInstanceName(String instanceName)`
`void`	`setMult(int multiplicity)`
`void`	`setName(String name)`
`void`	`setNamespace(String namespace)`
`void`	`setNamespacePrefix(String namespacePrefix)`
`void`	`setParent(AbstractTreeElement parent)`
`void`	`setPreloadHandler(String preloadHandler)`
`void`	`setPreloadParams(String preloadParams)`
`void`	`setRelevant(boolean relevant)`
`void`	`setRepeatable(boolean repeatable)`
`void`	`setRequired(boolean required)`
`void`	`setValue(IAnswerData value)`
`TreeElement`	`shallowCopy()`
`String`	`toString()`
`List<TreeReference>`	`tryBatchChildFetch(String name, int mult, List<XPathExpression> predicates, EvaluationContext evalContext)`	TODO: Worst method name ever.
`void`	`unregisterAll()`
`void`	`unregisterStateObserver(FormElementStateListener qsl)`
`void`	`writeExternal(DataOutputStream out)`

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details
- multiplicity
  
  protected int multiplicity
- dataType
  
  protected int dataType
Constructor Details
- TreeElement
  
  public TreeElement()
  
  TreeElement with null name and 0 multiplicity? (a "hidden root" node?)
- TreeElement
  
  public TreeElement(String name)
- TreeElement
  
  public TreeElement(String name, int multiplicity)
Method Details
- constructAttributeElement
  
  public static TreeElement constructAttributeElement(String namespace, String name, String value)
  
  Construct a TreeElement which represents an attribute with the provided namespace and name.
  
  Parameters:
  
  namespace - - if null will be converted to empty string
  
  name -
  
  value -
  
  Returns:
  
  A new instance of a TreeElement
- getAttribute
  
  public static TreeElement getAttribute(List<TreeElement> attributes, String namespace, String name)
  
  Retrieves the TreeElement representing the attribute for the provided namespace and name, or null if none exists.
  
  If 'null' is provided for the namespace, it will match the first attribute with the matching name.
  
  Parameters:
  
  attributes - - list of attributes to search
  
  namespace -
  
  name -
  
  Returns:
  
  TreeElement
- setAttribute
  
  public static void setAttribute(TreeElement parent, List<TreeElement> attrs, String namespace, String name, String value)
- isLeaf
  
  public boolean isLeaf()
  
  Specified by:
  
  isLeaf in interface AbstractTreeElement<TreeElement>
- isChildable
  
  public boolean isChildable()
  
  Specified by:
  
  isChildable in interface AbstractTreeElement<TreeElement>
- getInstanceName
  
  public String getInstanceName()
  
  Specified by:
  
  getInstanceName in interface AbstractTreeElement<TreeElement>
- setInstanceName
  
  public void setInstanceName(String instanceName)
- setValue
  
  public void setValue(IAnswerData value)
- getChild
  
  public TreeElement getChild(String name, int multiplicity)
  
  Specified by:
  
  getChild in interface AbstractTreeElement<TreeElement>
- getChildrenWithName
  
  public List<TreeElement> getChildrenWithName(String name)
  
  Description copied from interface: AbstractTreeElement
  
  Get all the child nodes of this element, with specific name
  
  Specified by:
  
  getChildrenWithName in interface AbstractTreeElement<TreeElement>
  
  Returns:
- getNumChildren
  
  public int getNumChildren()
  
  Specified by:
  
  getNumChildren in interface AbstractTreeElement<TreeElement>
- hasChildren
  
  public boolean hasChildren()
  
  Specified by:
  
  hasChildren in interface AbstractTreeElement<TreeElement>
- getChildAt
  
  public TreeElement getChildAt(int i)
  
  Specified by:
  
  getChildAt in interface AbstractTreeElement<TreeElement>
- isRepeatable
  
  public boolean isRepeatable()
  
  Specified by:
  
  isRepeatable in interface AbstractTreeElement<TreeElement>
- isAttribute
  
  public boolean isAttribute()
  
  Specified by:
  
  isAttribute in interface AbstractTreeElement<TreeElement>
- setDataType
  
  public void setDataType(int dataType)
- addChild
  
  public void addChild(TreeElement child)
- removeChild
  
  public void removeChild(TreeElement child)
- removeChild
  
  public void removeChild(String name, int multiplicity)
- removeChildren
  
  public void removeChildren(String name)
- removeChildAt
  
  public void removeChildAt(int i)
- getChildMultiplicity
  
  public int getChildMultiplicity(String name)
  
  Specified by:
  
  getChildMultiplicity in interface AbstractTreeElement<TreeElement>
- shallowCopy
  
  public TreeElement shallowCopy()
- deepCopy
  
  public TreeElement deepCopy(boolean includeTemplates)
- isRelevant
  
  public boolean isRelevant()
  
  Specified by:
  
  isRelevant in interface AbstractTreeElement<TreeElement>
- isEnabled
  
  public boolean isEnabled()
- setAnswer
  
  public boolean setAnswer(IAnswerData answer)
- setRequired
  
  public void setRequired(boolean required)
- setRelevant
  
  public void setRelevant(boolean relevant)
- setBindAttributes
  
  public void setBindAttributes(List<TreeElement> bindAttributes)
- getBindAttributes
  
  public List<TreeElement> getBindAttributes()
- getBindAttribute
  
  public TreeElement getBindAttribute(String namespace, String name)
  
  Retrieves the TreeElement representing an arbitrary bind attribute for this element at the provided namespace and name, or null if none exists.
  
  If 'null' is provided for the namespace, it will match the first attribute with the matching name.
  
  Returns:
  
  TreeElement
- getBindAttributeValue
  
  public String getBindAttributeValue(String namespace, String name)
  Returns the value of the given bind attribute from the given namespace.
  Example:
  
  Given a binding <bind assertion="blah"/>, calling getBindAttributeValue(null, "assertion") will return "blah"
  Given a binding <bind odk:assertion="blah"/>, calling getBindAttributeValue("odk", "assertion") will return "blah"
  Parameters:
  
  namespace - the namespace of the attribute. It can be null
  
  name - the name of the attribute
- setBindAttribute
  
  public void setBindAttribute(String namespace, String name, String value)
- setEnabled
  
  public void setEnabled(boolean enabled)
- setEnabled
  
  public void setEnabled(boolean enabled, boolean inherited)
- registerStateObserver
  
  public void registerStateObserver(FormElementStateListener qsl)
- unregisterStateObserver
  
  public void unregisterStateObserver(FormElementStateListener qsl)
- unregisterAll
  
  public void unregisterAll()
- alertStateObservers
  
  public void alertStateObservers(int changeFlags)
- accept
  
  public void accept(ITreeVisitor visitor)
  
  Description copied from interface: AbstractTreeElement
  
  Visitor pattern acceptance method.
  
  Specified by:
  
  accept in interface AbstractTreeElement<TreeElement>
  
  Parameters:
  
  visitor - The visitor traveling this tree
- getAttributeCount
  
  public int getAttributeCount()
  
  Description copied from interface: AbstractTreeElement
  
  Returns the number of attributes of this element.
  
  Specified by:
  
  getAttributeCount in interface AbstractTreeElement<TreeElement>
- getAttributeNamespace
  
  public String getAttributeNamespace(int index)
  
  Description copied from interface: AbstractTreeElement
  
  get namespace of attribute at 'index' in the list
  
  Specified by:
  
  getAttributeNamespace in interface AbstractTreeElement<TreeElement>
  
  Returns:
  
  String
- getAttributeName
  
  public String getAttributeName(int index)
  
  Description copied from interface: AbstractTreeElement
  
  get name of attribute at 'index' in the list
  
  Specified by:
  
  getAttributeName in interface AbstractTreeElement<TreeElement>
  
  Returns:
  
  String
- getAttributeValue
  
  public String getAttributeValue(int index)
  
  Description copied from interface: AbstractTreeElement
  
  get value of attribute at 'index' in the list
  
  Specified by:
  
  getAttributeValue in interface AbstractTreeElement<TreeElement>
  
  Returns:
  
  String
- getAttributeValue
  
  public String getAttributeValue()
- getAttribute
  
  public TreeElement getAttribute(String namespace, String name)
  
  Description copied from interface: AbstractTreeElement
  
  Retrieves the TreeElement representing the attribute at the provided namespace and name, or null if none exists. If 'null' is provided for the namespace, it will match the first attribute with the matching name.
  
  Specified by:
  
  getAttribute in interface AbstractTreeElement<TreeElement>
  
  Returns:
  
  TreeElement
- getAttributeValue
  
  public String getAttributeValue(String namespace, String name)
  
  Description copied from interface: AbstractTreeElement
  
  get value of attribute with namespace:name' in the list
  
  Specified by:
  
  getAttributeValue in interface AbstractTreeElement<TreeElement>
  
  Returns:
  
  String
- setAttribute
  
  public void setAttribute(String namespace, String name, String value)
- readExternal
  
  public void readExternal(DataInputStream in, PrototypeFactory pf) throws IOException, DeserializationException
  
  Specified by:
  
  readExternal in interface Externalizable
  
  Throws:
  
  IOException
  
  DeserializationException
- writeExternal
  
  public void writeExternal(DataOutputStream out) throws IOException
  
  Specified by:
  
  writeExternal in interface Externalizable
  
  Throws:
  
  IOException
- populate
  
  public void populate(TreeElement incoming, FormDef f)
- populateTemplate
  
  public void populateTemplate(TreeElement incoming, FormDef f)
- getRef
  
  public TreeReference getRef()
  
  Specified by:
  
  getRef in interface AbstractTreeElement<TreeElement>
- BuildRef
  
  public static TreeReference BuildRef(AbstractTreeElement elem)
- getDepth
  
  public int getDepth()
  
  Specified by:
  
  getDepth in interface AbstractTreeElement<TreeElement>
- CalculateDepth
  
  public static int CalculateDepth(AbstractTreeElement elem)
- getPreloadHandler
  
  public String getPreloadHandler()
- getConstraint
  
  public Constraint getConstraint()
- setPreloadHandler
  
  public void setPreloadHandler(String preloadHandler)
- setConstraint
  
  public void setConstraint(Constraint constraint)
- getPreloadParams
  
  public String getPreloadParams()
- setPreloadParams
  
  public void setPreloadParams(String preloadParams)
- getName
  
  public String getName()
  
  Specified by:
  
  getName in interface AbstractTreeElement<TreeElement>
- setName
  
  public void setName(String name)
- getMult
  
  public int getMult()
  
  Specified by:
  
  getMult in interface AbstractTreeElement<TreeElement>
- setMult
  
  public void setMult(int multiplicity)
- setParent
  
  public void setParent(AbstractTreeElement parent)
- getParent
  
  public AbstractTreeElement getParent()
  
  Specified by:
  
  getParent in interface AbstractTreeElement<TreeElement>
- getValue
  
  public IAnswerData getValue()
  
  Specified by:
  
  getValue in interface AbstractTreeElement<TreeElement>
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object
- getDataType
  
  public int getDataType()
  
  Specified by:
  
  getDataType in interface AbstractTreeElement<TreeElement>
- isRequired
  
  public boolean isRequired()
- setRepeatable
  
  public void setRepeatable(boolean repeatable)
- getMultiplicity
  
  public int getMultiplicity()
- clearCaches
  
  public void clearCaches()
  
  Specified by:
  
  clearCaches in interface AbstractTreeElement<TreeElement>
- clearChildrenCaches
  
  public void clearChildrenCaches()
- getNamespace
  
  public String getNamespace()
  
  Specified by:
  
  getNamespace in interface AbstractTreeElement<TreeElement>
- setNamespace
  
  public void setNamespace(String namespace)
- tryBatchChildFetch
  
  public List<TreeReference> tryBatchChildFetch(String name, int mult, List<XPathExpression> predicates, EvaluationContext evalContext)
  
  Description copied from interface: AbstractTreeElement
  
  TODO: Worst method name ever. Don't use this unless you know what's up.
  
  Specified by:
  
  tryBatchChildFetch in interface AbstractTreeElement<TreeElement>
  
  predicates - possibly list of predicates to be evaluated. predicates will be removed from list if they are able to be evaluated
  
  Returns:
- getNamespacePrefix
  
  public String getNamespacePrefix()
- setNamespacePrefix
  
  public void setNamespacePrefix(String namespacePrefix)

Class TreeElement

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details