org.javarosa.core.model.instance

Interface AbstractTreeElement<T extends AbstractTreeElement>

All Known Implementing Classes:

TreeElement

public interface AbstractTreeElement<T extends AbstractTreeElement>

Method Summary

Modifier and Type	Method and Description
void	accept(ITreeVisitor visitor) Visitor pattern acceptance method.
void	clearCaches()
T	getAttribute(String namespace, String name) Retrieves the TreeElement representing the attribute at 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(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
T	getChild(String name, int multiplicity)
T	getChildAt(int i)
int	getChildMultiplicity(String name)
List<T>	getChildrenWithName(String name) Get all the child nodes of this element, with specific name
int	getDataType()
int	getDepth()
T	getFirstChild(String name)
T	getFirstChild(String namespace, String name)
String	getInstanceName()
int	getMult()
String	getName()
String	getNamespace()
int	getNumChildren()
AbstractTreeElement	getParent()
TreeReference	getRef()
IAnswerData	getValue()
boolean	hasChildren()
boolean	isAttribute()
boolean	isChildable()
boolean	isLeaf()
boolean	isRelevant()
boolean	isRepeatable()
List<TreeReference>	tryBatchChildFetch(String name, int mult, List<XPathExpression> predicates, EvaluationContext evalContext) TODO: Worst method name ever.

Method Detail

isLeaf

boolean isLeaf()

isChildable

boolean isChildable()

getInstanceName

String getInstanceName()

getFirstChild

@Nullable
T getFirstChild(String name)

getFirstChild

@Nullable
T getFirstChild(String namespace,
                          String name)

getChild

@Nullable
T getChild(String name,
                     int multiplicity)

getChildrenWithName

List<T> getChildrenWithName(String name)

Get all the child nodes of this element, with specific name

Parameters:

name -

Returns:

hasChildren

boolean hasChildren()

getNumChildren

int getNumChildren()

getChildAt

T getChildAt(int i)

isRepeatable

boolean isRepeatable()

isAttribute

boolean isAttribute()

getChildMultiplicity

int getChildMultiplicity(String name)

accept

void accept(ITreeVisitor visitor)

Visitor pattern acceptance method.

Parameters:

visitor - The visitor traveling this tree

getAttributeCount

int getAttributeCount()

Returns the number of attributes of this element.

getAttributeNamespace

String getAttributeNamespace(int index)

get namespace of attribute at 'index' in the list

Parameters:

index -

Returns:

String

getAttributeName

String getAttributeName(int index)

get name of attribute at 'index' in the list

Parameters:

index -

Returns:

String

getAttributeValue

String getAttributeValue(int index)

get value of attribute at 'index' in the list

Parameters:

index -

Returns:

String

getAttribute

T getAttribute(String namespace,
               String name)

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.

Returns:

TreeElement

getAttributeValue

String getAttributeValue(String namespace,
                         String name)

get value of attribute with namespace:name' in the list

Returns:

String

getRef

TreeReference getRef()

getDepth

int getDepth()

getName

String getName()

getMult

int getMult()

getParent

AbstractTreeElement getParent()

getValue

@Nullable
IAnswerData getValue()

getDataType

int getDataType()

clearCaches

void clearCaches()

isRelevant

boolean isRelevant()

getNamespace

String getNamespace()

tryBatchChildFetch

List<TreeReference> tryBatchChildFetch(String name,
                                       int mult,
                                       List<XPathExpression> predicates,
                                       EvaluationContext evalContext)

TODO: Worst method name ever. Don't use this unless you know what's up.

Parameters:

name -

mult -

predicates - possibly list of predicates to be evaluated. predicates will be removed from list if they are able to be evaluated

evalContext -

Returns: