org.javarosa.core.model.instance

Class ExternalDataInstance

java.lang.Object

org.javarosa.core.model.instance.DataInstance

org.javarosa.core.model.instance.ExternalDataInstance

All Implemented Interfaces:

Persistable, Externalizable

public class ExternalDataInstance
extends DataInstance

Field Summary

Fields

Modifier and Type	Field and Description
static TreeElement	PLACEHOLDER_ROOT

Constructor Summary

Constructors

Constructor and Description
ExternalDataInstance() No-args constructor for deserialization

Method Summary

Modifier and Type	Method and Description
static ExternalDataInstance	build(String instanceSrc, String instanceId) Builds an ExternalDataInstance by parsing the file at the given location or fills in a placeholder if the file can't be found or derived.
AbstractTreeElement	getBase()
AbstractTreeElement	getRoot()
void	initialize(InstanceInitializationFactory initializer, String instanceId)
boolean	isUsingPlaceholder()
void	readExternal(DataInputStream in, PrototypeFactory pf)
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

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

Field Detail

PLACEHOLDER_ROOT

public static final TreeElement PLACEHOLDER_ROOT

Constructor Detail

ExternalDataInstance

public ExternalDataInstance()

No-args constructor for deserialization

Method Detail

build

public static ExternalDataInstance build(String instanceSrc,
                                         String instanceId)
                                  throws IOException,
                                         UnfullfilledRequirementsException,
                                         org.xmlpull.v1.XmlPullParserException,
                                         InvalidStructureException

Builds an ExternalDataInstance by parsing the file at the given location or fills in a placeholder if the file can't be found or derived. The placeholder makes it possible to successfully parse a form without an external instance in cases where a client isn't providing a form-filling interface (e.g. form validation or discovery).

Parameters:

instanceSrc - the value of the instance’s src attribute, e.g., jr://file/…

instanceId - the ID of the new instance

Returns:

a new ExternalDataInstance

Throws:

IOException - if ElementParser can’t read the stream

UnfullfilledRequirementsException - thrown by TreeElementParser.parse()

org.xmlpull.v1.XmlPullParserException - thrown by TreeElementParser.parse()

InvalidStructureException - thrown by TreeElementParser.parse()

getBase

public AbstractTreeElement getBase()

Specified by:

getBase in class DataInstance

getRoot

public AbstractTreeElement getRoot()

Specified by:

getRoot in class DataInstance

isUsingPlaceholder

public boolean isUsingPlaceholder()

initialize

public void initialize(InstanceInitializationFactory initializer,
                       String instanceId)

Specified by:

initialize in class DataInstance

readExternal

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

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class DataInstance

Throws:

IOException

DeserializationException

writeExternal

public void writeExternal(DataOutputStream out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class DataInstance

Throws:

IOException