org.javarosa.core.model.instance

Class FormInstance

java.lang.Object

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

org.javarosa.core.model.instance.FormInstance

All Implemented Interfaces:

IMetaData, Persistable, Externalizable

public class FormInstance
extends DataInstance<TreeElement>
implements Persistable, IMetaData

This class represents the xform model instance

Field Summary

Fields

Modifier and Type	Field and Description
String	formVersion
static String	META_ID
static String	META_XMLNS
String	schema
static String	STORAGE_KEY
String	uiVersion

Constructor Summary

Constructors

Constructor and Description
FormInstance()
FormInstance(TreeElement root)
FormInstance(TreeElement root, String id) Creates a new instance using the provided document root.

Method Summary

Modifier and Type	Method and Description
void	accept(IInstanceVisitor visitor)
void	addNamespace(String prefix, String URI)
TreeReference	addNode(TreeReference ambigRef)
TreeReference	addNode(TreeReference ambigRef, IAnswerData data, int dataType)
FormInstance	clone()
void	copyItemsetNode(TreeElement copyNode, TreeReference destRef, FormDef f)
TreeElement	copyNode(TreeElement src, TreeReference to)
TreeReference	copyNode(TreeReference from, TreeReference to)
TreeElement	getBase()
Date	getDateSaved()
HashMap<String,Object>	getMetaData()
Object	getMetaData(String fieldName)
String[]	getMetaDataFields()
String[]	getNamespacePrefixes()
String	getNamespaceURI(String prefix)
TreeElement	getRoot() Get this instance's document root which is the root's first child.
void	initialize(InstanceInitializationFactory initializer, String instanceId)
static boolean	isHomogeneous(TreeElement a, TreeElement b)
TreeElement	processSaved(FormInstance template, FormDef f)
void	readExternal(DataInputStream in, PrototypeFactory pf)
void	setDateSaved(Date dateSaved)
void	setRoot(TreeElement topLevel) Sets the root element of this instance's tree.
void	writeExternal(DataOutputStream out)

Methods inherited from class org.javarosa.core.model.instance.DataInstance

explodeReference, getFormId, getID, getInstanceId, getName, getTemplate, getTemplatePath, hasTemplatePath, isRuntimeEvaluated, resolveReference, resolveReference, setFormId, setID, setInstanceId, setName, toString, unpackReference

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.javarosa.core.services.storage.Persistable

getID, setID

Field Detail

STORAGE_KEY

public static final String STORAGE_KEY

See Also:

Constant Field Values

schema

public String schema

formVersion

public String formVersion

uiVersion

public String uiVersion

META_XMLNS

public static final String META_XMLNS

See Also:

Constant Field Values

META_ID

public static final String META_ID

See Also:

Constant Field Values

Constructor Detail

FormInstance

public FormInstance()

FormInstance

public FormInstance(TreeElement root)

FormInstance

public FormInstance(TreeElement root,
                    String id)

Creates a new instance using the provided document root.

Method Detail

getBase

public TreeElement getBase()

Specified by:

getBase in class DataInstance<TreeElement>

getRoot

public TreeElement getRoot()

Get this instance's document root which is the root's first child.

Specified by:

getRoot in class DataInstance<TreeElement>

setRoot

public void setRoot(TreeElement topLevel)

Sets the root element of this instance's tree. Builds the root node and attaches the root element to it.

copyNode

public TreeReference copyNode(TreeReference from,
                              TreeReference to)
                       throws InvalidReferenceException

Throws:

InvalidReferenceException

copyNode

public TreeElement copyNode(TreeElement src,
                            TreeReference to)
                     throws InvalidReferenceException

Throws:

InvalidReferenceException

getDateSaved

public Date getDateSaved()

addNode

public TreeReference addNode(TreeReference ambigRef)

addNode

public TreeReference addNode(TreeReference ambigRef,
                             IAnswerData data,
                             int dataType)

addNamespace

public void addNamespace(String prefix,
                         String URI)

getNamespacePrefixes

public String[] getNamespacePrefixes()

getNamespaceURI

public String getNamespaceURI(String prefix)

processSaved

public TreeElement processSaved(FormInstance template,
                                FormDef f)

clone

public FormInstance clone()

Overrides:

clone in class Object

readExternal

public void readExternal(DataInputStream in,
                         PrototypeFactory pf)
                  throws IOException,
                         DeserializationException

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class DataInstance<TreeElement>

Throws:

IOException

DeserializationException

writeExternal

public void writeExternal(DataOutputStream out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class DataInstance<TreeElement>

Throws:

IOException

setDateSaved

public void setDateSaved(Date dateSaved)

copyItemsetNode

public void copyItemsetNode(TreeElement copyNode,
                            TreeReference destRef,
                            FormDef f)
                     throws InvalidReferenceException

Throws:

InvalidReferenceException

accept

public void accept(IInstanceVisitor visitor)

isHomogeneous

public static boolean isHomogeneous(TreeElement a,
                                    TreeElement b)

initialize

public void initialize(InstanceInitializationFactory initializer,
                       String instanceId)

Specified by:

initialize in class DataInstance<TreeElement>

getMetaDataFields

public String[] getMetaDataFields()

Specified by:

getMetaDataFields in interface IMetaData

getMetaData

public HashMap<String,Object> getMetaData()

Specified by:

getMetaData in interface IMetaData

getMetaData

public Object getMetaData(String fieldName)

Specified by:

getMetaData in interface IMetaData