org.javarosa.xform.parse

Class XFormParser

java.lang.Object

org.javarosa.xform.parse.XFormParser

All Implemented Interfaces:

IXFormParserFunctions

public class XFormParser
extends Object
implements IXFormParserFunctions

Provides conversion from xform to epihandy object model and vice vasa.

Author:

Daniel Kayiwa, Drew Roos

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	XFormParser.BindAttributeProcessor
static interface	XFormParser.ErrorCallback
static interface	XFormParser.FormDefProcessor
static class	XFormParser.MissingModelAttributeException
static interface	XFormParser.ModelAttributeProcessor
static class	XFormParser.ParseException
static interface	XFormParser.Processor
static interface	XFormParser.WarningCallback

Field Summary

Fields

Modifier and Type	Field and Description
static String	EVENT_ATTR
static String	ITEXT_CLOSE
static String	ITEXT_OPEN
static String	NAMESPACE_JAVAROSA
static String	NAMESPACE_ODK

Constructor Summary

Constructors

Constructor and Description
XFormParser(org.kxml2.kdom.Document doc)
XFormParser(org.kxml2.kdom.Document form, org.kxml2.kdom.Document instance)
XFormParser(Reader reader)
XFormParser(Reader form, Reader instance)

Method Summary

Modifier and Type	Method and Description
void	addBindAttributeProcessor(XFormParser.BindAttributeProcessor bindAttributeProcessor)
void	addFormDefProcessor(XFormParser.FormDefProcessor formDefProcessor)
void	addModelAttributeProcessor(XFormParser.ModelAttributeProcessor modelAttributeProcessor)
void	addProcessor(XFormParser.Processor processor)
static TreeElement	buildInstanceStructure(org.kxml2.kdom.Element node, TreeElement parent, Map<String,String> namespacePrefixesByUri, Integer multiplicityFromGroup)
static TreeElement	buildInstanceStructure(org.kxml2.kdom.Element node, TreeElement parent, String instanceName, String docnamespace, Map<String,String> namespacePrefixesByUri, Integer multiplicityFromGroup) Parses instance hierarchy and turns into a skeleton model; ignoring data content, but respecting repeated nodes and 'template' flags
IDataReference	getAbsRef(IDataReference ref, IFormElement parent)
static IAnswerResolver	getAnswerResolver()
static String	getVagueLocation(org.kxml2.kdom.Element e)
static List<String>	getValidEventNames(String eventsString)
static org.kxml2.kdom.Document	getXMLDocument(Reader reader)
static org.kxml2.kdom.Document	getXMLDocument(Reader reader, CacheTable<String> stringCache) Deprecated. The InterningKXmlParser is not used.
static String	getXMLText(org.kxml2.kdom.Node n, boolean trim)
static String	getXMLText(org.kxml2.kdom.Node node, int i, boolean trim) reads all subsequent text nodes and returns the combined string needed because escape sequences are parsed into consecutive text nodes e.g.
static QuestionDef	ghettoGetQuestionDef(int dataType, FormDef f, TreeReference ref) Finds a questiondef that binds to ref, if the data type is a 'select' question type
void	onError(XFormParser.ErrorCallback callback)
void	onWarning(XFormParser.WarningCallback callback)
FormDef	parse()
FormDef	parse(String lastSavedSrc)
FormDef	parse(String formXmlSrc, String lastSavedSrc)
void	parseSetValueAction(ActionController source, org.kxml2.kdom.Element e)
protected QuestionDef	parseUpload(IFormElement parent, org.kxml2.kdom.Element e, int controlUpload)
static void	recordInstanceFunctionCall(String instanceId) Records that the given instance ID was used as the argument to an instance() function call.
static void	registerActionHandler(String name, IElementHandler specificHandler) Let the parser know how to handle a given action -- All actions are first parsed by the generic parseAction() method, which is passed another handler to invoke after the generic handler is done
void	registerActionTarget(TreeReference target) Notify parser about a node that will later be relevant to an action.
static FormInstance	restoreDataModel(byte[] data, Class restorableType)
static FormInstance	restoreDataModel(org.kxml2.kdom.Document doc, Class restorableType)
static FormInstance	restoreDataModel(InputStream input, Class restorableType)
static void	setAnswerResolver(IAnswerResolver answerResolver)

Methods inherited from class java.lang.Object

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

Field Detail

NAMESPACE_JAVAROSA

public static final String NAMESPACE_JAVAROSA

See Also:

Constant Field Values

NAMESPACE_ODK

public static final String NAMESPACE_ODK

See Also:

Constant Field Values

ITEXT_CLOSE

public static final String ITEXT_CLOSE

See Also:

Constant Field Values

ITEXT_OPEN

public static final String ITEXT_OPEN

See Also:

Constant Field Values

EVENT_ATTR

public static final String EVENT_ATTR

See Also:

Constant Field Values

Constructor Detail

XFormParser

public XFormParser(Reader reader)

XFormParser

public XFormParser(org.kxml2.kdom.Document doc)

XFormParser

public XFormParser(Reader form,
                   Reader instance)

XFormParser

public XFormParser(org.kxml2.kdom.Document form,
                   org.kxml2.kdom.Document instance)

Method Detail

getAnswerResolver

public static IAnswerResolver getAnswerResolver()

setAnswerResolver

public static void setAnswerResolver(IAnswerResolver answerResolver)

parse

public FormDef parse(String lastSavedSrc)
              throws XFormParser.ParseException

Throws:

XFormParser.ParseException

parse

public FormDef parse()
              throws XFormParser.ParseException

Throws:

XFormParser.ParseException

parse

public FormDef parse(String formXmlSrc,
                     String lastSavedSrc)
              throws XFormParser.ParseException

Parameters:

formXmlSrc - The path of the form definition.

lastSavedSrc - The src of the last-saved instance of this form (for auto-filling). If null, no data will be loaded and the instance will be blank.

Throws:

XFormParser.ParseException

addProcessor

public void addProcessor(XFormParser.Processor processor)

addBindAttributeProcessor

public void addBindAttributeProcessor(XFormParser.BindAttributeProcessor bindAttributeProcessor)

addFormDefProcessor

public void addFormDefProcessor(XFormParser.FormDefProcessor formDefProcessor)

addModelAttributeProcessor

public void addModelAttributeProcessor(XFormParser.ModelAttributeProcessor modelAttributeProcessor)

getXMLDocument

public static org.kxml2.kdom.Document getXMLDocument(Reader reader)
                                              throws IOException

Throws:

IOException

getXMLDocument

@Deprecated
public static org.kxml2.kdom.Document getXMLDocument(Reader reader,
                                                                 CacheTable<String> stringCache)
                                                          throws IOException

Deprecated. The InterningKXmlParser is not used.

Uses xkml to parse the provided XML content, and then consolidates text elements.

Parameters:

reader - the XML content provider

stringCache - an optional string cache, whose presence will cause the use of InterningKXmlParser rather than KXmlParser.

Returns:

the parsed document

Throws:

IOException

recordInstanceFunctionCall

public static void recordInstanceFunctionCall(String instanceId)

Records that the given instance ID was used as the argument to an instance() function call.

getValidEventNames

public static List<String> getValidEventNames(String eventsString)

parseSetValueAction

public void parseSetValueAction(ActionController source,
                                org.kxml2.kdom.Element e)

parseUpload

protected QuestionDef parseUpload(IFormElement parent,
                                  org.kxml2.kdom.Element e,
                                  int controlUpload)
                           throws XFormParser.ParseException

Throws:

XFormParser.ParseException

getAbsRef

public IDataReference getAbsRef(IDataReference ref,
                                IFormElement parent)

Specified by:

getAbsRef in interface IXFormParserFunctions

buildInstanceStructure

public static TreeElement buildInstanceStructure(org.kxml2.kdom.Element node,
                                                 TreeElement parent,
                                                 Map<String,String> namespacePrefixesByUri,
                                                 Integer multiplicityFromGroup)

buildInstanceStructure

public static TreeElement buildInstanceStructure(org.kxml2.kdom.Element node,
                                                 TreeElement parent,
                                                 String instanceName,
                                                 String docnamespace,
                                                 Map<String,String> namespacePrefixesByUri,
                                                 Integer multiplicityFromGroup)

Parses instance hierarchy and turns into a skeleton model; ignoring data content, but respecting repeated nodes and 'template' flags

Parameters:

node - the input node

parent - the parent

instanceName - the name of the instance

docnamespace -

namespacePrefixesByUri - namespace prefixes, by URI

multiplicityFromGroup - if not null, the multiplicity to use. If present, a potentially expensive search can be avoided.

Returns:

a new TreeElement

ghettoGetQuestionDef

public static QuestionDef ghettoGetQuestionDef(int dataType,
                                               FormDef f,
                                               TreeReference ref)

Finds a questiondef that binds to ref, if the data type is a 'select' question type

registerActionHandler

public static void registerActionHandler(String name,
                                         IElementHandler specificHandler)

Let the parser know how to handle a given action -- All actions are first parsed by the generic parseAction() method, which is passed another handler to invoke after the generic handler is done

Parameters:

specificHandler - the handler for the specific action indicated by name, which is passed to and invoked by the generic parseAction() handler

registerActionTarget

public void registerActionTarget(TreeReference target)

Notify parser about a node that will later be relevant to an action.

getXMLText

public static String getXMLText(org.kxml2.kdom.Node n,
                                boolean trim)

getXMLText

public static String getXMLText(org.kxml2.kdom.Node node,
                                int i,
                                boolean trim)

reads all subsequent text nodes and returns the combined string needed because escape sequences are parsed into consecutive text nodes e.g. "abc&123" --> (abc)(&)(123)

restoreDataModel

public static FormInstance restoreDataModel(InputStream input,
                                            Class restorableType)
                                     throws IOException

Throws:

IOException

restoreDataModel

public static FormInstance restoreDataModel(org.kxml2.kdom.Document doc,
                                            Class restorableType)

restoreDataModel

public static FormInstance restoreDataModel(byte[] data,
                                            Class restorableType)

getVagueLocation

public static String getVagueLocation(org.kxml2.kdom.Element e)

onWarning

public void onWarning(XFormParser.WarningCallback callback)

onError

public void onError(XFormParser.ErrorCallback callback)