org.javarosa.core.model.instance

Class DataInstance<T extends AbstractTreeElement<T>>

java.lang.Object

org.javarosa.core.model.instance.DataInstance<T>

All Implemented Interfaces:

Persistable, Externalizable

Direct Known Subclasses:

ExternalDataInstance, FormInstance

public abstract class DataInstance<T extends AbstractTreeElement<T>>
extends Object
implements Persistable

A data instance represents a tree structure of abstract tree elements which can be accessed and read with tree references. It is a supertype of different types of concrete models which may or may not be read only.

Author:

ctsims

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataInstance.PartialElementEncounteredException

Constructor Summary

Constructors

Constructor and Description
DataInstance()
DataInstance(String instanceid)

Method Summary

Modifier and Type	Method and Description
List<AbstractTreeElement<T>>	explodeReference(TreeReference ref)
abstract AbstractTreeElement<T>	getBase()
int	getFormId()
int	getID()
String	getInstanceId()
String	getName()
abstract T	getRoot()
T	getTemplate(TreeReference ref)
T	getTemplatePath(TreeReference ref)
boolean	hasTemplatePath(TreeReference ref) Determines if a path exists for a reference; template elements are followed when available.
abstract void	initialize(InstanceInitializationFactory initializer, String instanceId)
boolean	isRuntimeEvaluated() Whether the structure of this instance is only available at runtime.
void	readExternal(DataInputStream in, PrototypeFactory pf)
void	replacePartialElements(List<TreeElement> elements)
T	resolveReference(IDataReference binding)
T	resolveReference(TreeReference ref)
void	setFormId(int formId)
void	setID(int recordid)
protected void	setInstanceId(String instanceid)
void	setName(String name)
String	toString()
static TreeReference	unpackReference(IDataReference ref)
void	writeExternal(DataOutputStream out)

Methods inherited from class java.lang.Object

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

Constructor Detail

DataInstance

public DataInstance()

DataInstance

public DataInstance(String instanceid)

Method Detail

unpackReference

public static TreeReference unpackReference(IDataReference ref)

getBase

public abstract AbstractTreeElement<T> getBase()

getRoot

public abstract T getRoot()

getInstanceId

public String getInstanceId()

setInstanceId

protected void setInstanceId(String instanceid)

isRuntimeEvaluated

public boolean isRuntimeEvaluated()

Whether the structure of this instance is only available at runtime.

Returns:

true if the instance structure is available and runtime and can't be checked for consistency until the reference is made available. False otherwise.

resolveReference

public T resolveReference(TreeReference ref)

explodeReference

public List<AbstractTreeElement<T>> explodeReference(TreeReference ref)

getTemplate

public T getTemplate(TreeReference ref)

getTemplatePath

public T getTemplatePath(TreeReference ref)

hasTemplatePath

public boolean hasTemplatePath(TreeReference ref)

Determines if a path exists for a reference; template elements are followed when available. Non-absolute references aren't followed.

Parameters:

ref - the reference path to be followed

Returns:

was a valid path found for the reference?

resolveReference

public T resolveReference(IDataReference binding)

setFormId

public void setFormId(int formId)

getFormId

public int getFormId()

getName

public String getName()

setName

public void setName(String name)

toString

public String toString()

Overrides:

toString in class Object

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

getID

public int getID()

Specified by:

getID in interface Persistable

setID

public void setID(int recordid)

Specified by:

setID in interface Persistable

initialize

public abstract void initialize(InstanceInitializationFactory initializer,
                                String instanceId)

replacePartialElements

public void replacePartialElements(List<TreeElement> elements)