org.javarosa.core.model.instance

Class TreeReference

java.lang.Object

org.javarosa.core.model.instance.TreeReference

All Implemented Interfaces:

Serializable, Externalizable

public class TreeReference
extends Object
implements Externalizable, Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONTEXT_ABSOLUTE
static int	CONTEXT_INHERITED
static int	CONTEXT_INSTANCE
static int	CONTEXT_ORIGINAL
static int	DEFAULT_MULTIPLICITY Multiplicity demarcates the position of a given element with respect to other elements of the same name.
static int	DEFAULT_MUTLIPLICITY Deprecated. replaced by DEFAULT_MULTIPLICITY
static int	INDEX_ATTRIBUTE Multiplicity flag for an attribute
static int	INDEX_REPEAT_JUNCTURE
static int	INDEX_TEMPLATE 'repeats' (sections of a form that can multiply themselves) are populated with a template that never exists in the form (IE: If you serialized the form to XML it wouldn't be there) but provides the xml structure that should be replicated when a 'repeat' is added
static int	INDEX_UNBOUND Refers to all instances of an element, e.g.
static String	NAME_WILDCARD
static int	REF_ABSOLUTE

Constructor Summary

Constructors

Constructor and Description
TreeReference()

Method Summary

Modifier and Type	Method and Description
void	add(String name, int mult)
void	addPredicate(int key, List<XPathExpression> xpe)
TreeReference	anchor(TreeReference baseReference) Builds and returns a new reference that is this reference anchored to a passed-in base reference.
TreeReference	clone()
TreeReference	contextualize(TreeReference contextRef)
boolean	equals(Object o)
TreeReference	extendRef(String name, int mult) clone and extend a reference by one level
TreeReference	genericize()
int	getContext() Deprecated. use #getContextType() instead
int	getContextType()
String	getInstanceName()
int	getMultiplicity(int index)
int	getMultLast()
String	getName(int index)
String	getNameLast()
TreeReference	getParentRef()
List<XPathExpression>	getPredicate(int key)
int	getRefLevel()
TreeReference	getSubReference(int level) Returns the subreference of this reference up to the level specified.
int	hashCode()
boolean	hasPredicates()
void	incrementRefLevel()
TreeReference	intersect(TreeReference b) Intersect this tree reference with another, returning a new tree reference which contains all of the common elements, starting with the root element.
boolean	isAbsolute()
boolean	isAmbiguous()
boolean	isAncestorOf(TreeReference child, boolean properParent)
boolean	isParentOf(TreeReference child, boolean properParent) Deprecated. replaced by isAncestorOf(TreeReference, boolean)
TreeReference	parent(TreeReference baseReference) Builds and returns a new reference that is this reference anchored to a passed-in base reference.
void	readExternal(DataInputStream in, PrototypeFactory pf)
TreeReference	relativize(TreeReference parent)
boolean	removeLastLevel()
TreeReference	removePredicates()
TreeReference	removePredicates(int i)
static TreeReference	rootRef()
static TreeReference	selfRef()
void	setContext(int contextType) Deprecated. use #setContextType(int) instead
void	setContextType(int contextType)
void	setInstanceName(String instanceName)
void	setMultiplicity(int i, int mult)
void	setRefLevel(int refLevel)
int	size()
String	toShortString()
String	toString()
String	toString(boolean includePredicates)
String	toString(boolean includePredicates, boolean zeroIndexMult)
void	writeExternal(DataOutputStream out)

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_MUTLIPLICITY

@Deprecated
public static final int DEFAULT_MUTLIPLICITY

Deprecated. replaced by DEFAULT_MULTIPLICITY

See Also:

Constant Field Values

DEFAULT_MULTIPLICITY

public static final int DEFAULT_MULTIPLICITY

Multiplicity demarcates the position of a given element with respect to other elements of the same name.

Since users usually want to select the first instance from the nodeset returned from a reference query, let the default multiplicity be selecting the first node.

See Also:

Constant Field Values

INDEX_UNBOUND

public static final int INDEX_UNBOUND

Refers to all instances of an element, e.g. /data/b[-1] refers to b[0] and b[1]

See Also:

Constant Field Values

INDEX_TEMPLATE

public static final int INDEX_TEMPLATE

'repeats' (sections of a form that can multiply themselves) are populated with a template that never exists in the form (IE: If you serialized the form to XML it wouldn't be there) but provides the xml structure that should be replicated when a 'repeat' is added

See Also:

Constant Field Values

INDEX_ATTRIBUTE

public static final int INDEX_ATTRIBUTE

Multiplicity flag for an attribute

See Also:

Constant Field Values

INDEX_REPEAT_JUNCTURE

public static final int INDEX_REPEAT_JUNCTURE

See Also:

Constant Field Values

CONTEXT_ABSOLUTE

public static final int CONTEXT_ABSOLUTE

See Also:

Constant Field Values

CONTEXT_INHERITED

public static final int CONTEXT_INHERITED

See Also:

Constant Field Values

CONTEXT_ORIGINAL

public static final int CONTEXT_ORIGINAL

See Also:

Constant Field Values

CONTEXT_INSTANCE

public static final int CONTEXT_INSTANCE

See Also:

Constant Field Values

REF_ABSOLUTE

public static final int REF_ABSOLUTE

See Also:

Constant Field Values

NAME_WILDCARD

public static final String NAME_WILDCARD

See Also:

Constant Field Values

Constructor Detail

TreeReference

public TreeReference()

Method Detail

rootRef

public static TreeReference rootRef()

selfRef

public static TreeReference selfRef()

getInstanceName

public String getInstanceName()

setInstanceName

public void setInstanceName(String instanceName)

getMultiplicity

public int getMultiplicity(int index)

getName

public String getName(int index)

getMultLast

public int getMultLast()

getNameLast

public String getNameLast()

setMultiplicity

public void setMultiplicity(int i,
                            int mult)

size

public int size()

add

public void add(String name,
                int mult)

addPredicate

public void addPredicate(int key,
                         List<XPathExpression> xpe)

getPredicate

public List<XPathExpression> getPredicate(int key)

getRefLevel

public int getRefLevel()

setRefLevel

public void setRefLevel(int refLevel)

incrementRefLevel

public void incrementRefLevel()

isAbsolute

public boolean isAbsolute()

isAmbiguous

public boolean isAmbiguous()

clone

public TreeReference clone()

Overrides:

clone in class Object

removeLastLevel

public boolean removeLastLevel()

getParentRef

public TreeReference getParentRef()

parent

public TreeReference parent(TreeReference baseReference)

Builds and returns a new reference that is this reference anchored to a passed-in base reference.

Unlike in anchor(TreeReference), the base reference can be relative. This allows anchoring of nodes with inherited context such as in TreeElement.BuildRef(org.javarosa.core.model.instance.AbstractTreeElement) which anchor can't do. However, if this ref has 'parent' steps (..), it can only be anchored if the base ref is a relative ref consisting only of other 'parent' steps. For example, '../../a'.parent('..') is valid and yields '../../../a'.

Returns:

a new TreeReference that represents this reference anchored to the parent or null if this ref has parent steps and the parent ref is not a relative reference consisting only of other 'parent' steps.

anchor

public TreeReference anchor(TreeReference baseReference)
                     throws XPathException

Builds and returns a new reference that is this reference anchored to a passed-in base reference.

Unlike in parent(TreeReference), the base reference must be absolute and refer to a singular, existing node in the model. For example, this allows '../../d/e/f'.anchor('/a/b/c') -> '/a/d/e/f' which can't be done by parent(TreeReference).

NOTE: this function still works even when baseReference contains INDEX_UNBOUND multiplicities. Conditions depend on this behavior, even though it's slightly icky.

TODO: Technically we should possibly be modifying context stuff here instead of in the xpath stuff

Returns:

a new TreeReference that represents this reference anchored to the context.

Throws:

XPathException - if the context reference is not absolute or if there is an attempt to parent past the root node (too many '../' levels).

contextualize

public TreeReference contextualize(TreeReference contextRef)

relativize

public TreeReference relativize(TreeReference parent)

genericize

public TreeReference genericize()

isParentOf

@Deprecated
public boolean isParentOf(TreeReference child,
                                      boolean properParent)

Deprecated. replaced by isAncestorOf(TreeReference, boolean)

isAncestorOf

public boolean isAncestorOf(TreeReference child,
                            boolean properParent)

extendRef

public TreeReference extendRef(String name,
                               int mult)

clone and extend a reference by one level

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toString

public String toString(boolean includePredicates)

toString

public String toString(boolean includePredicates,
                       boolean zeroIndexMult)

toShortString

public String toShortString()

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

intersect

public TreeReference intersect(TreeReference b)

Intersect this tree reference with another, returning a new tree reference which contains all of the common elements, starting with the root element.

Note that relative references by their nature can't share steps, so intersecting any (or by any) relative ref will result in the root ref. Additionally, if the two references don't share any steps, the intersection will consist of the root reference.

Parameters:

b - The tree reference to intersect

Returns:

The tree reference containing the common basis of this ref and b

setContext

@Deprecated
public void setContext(int contextType)

Deprecated. use #setContextType(int) instead

setContextType

public void setContextType(int contextType)

getContext

@Deprecated
public int getContext()

Deprecated. use #getContextType() instead

getContextType

public int getContextType()

getSubReference

public TreeReference getSubReference(int level)

Returns the subreference of this reference up to the level specified.

Used to identify the reference context for a predicate at the same level

Must be an absolute reference, otherwise will throw IllegalArgumentException

hasPredicates

public boolean hasPredicates()

removePredicates

public TreeReference removePredicates()

removePredicates

public TreeReference removePredicates(int i)