org.javarosa.xform.util

Class XFormUtils

java.lang.Object

org.javarosa.xform.util.XFormUtils

public class XFormUtils
extends Object

Static Utility methods pertaining to XForms.

Author:

Clayton Sims

Constructor Summary

Constructors

Constructor and Description
XFormUtils()

Method Summary

Modifier and Type	Method and Description
static List<String>	getAttributeList(org.kxml2.kdom.Element e)
static FormDef	getFormFromFormXml(String formXmlSrc, String lastSavedSrc)
static FormDef	getFormFromInputStream(InputStream is) Parses a form with an external secondary instance, and returns a FormDef.
static FormDef	getFormFromInputStream(InputStream is, String lastSavedSrc)
static FormDef	getFormFromResource(String resource)
static FormDef	getFormFromSerializedResource(String resource)
static FormDef	getFormRaw(InputStreamReader isr)
static List<String>	getUnusedAttributes(org.kxml2.kdom.Element e, List<String> usedAtts)
static boolean	isOutput(org.kxml2.kdom.Element e) Is this element an Output tag?
static IXFormParserFactory	setXFormParserFactory(IXFormParserFactory factory)
static boolean	showUnusedAttributeWarning(org.kxml2.kdom.Element e, List<String> usedAtts)
static String	unusedAttWarning(org.kxml2.kdom.Element e, List<String> usedAtts)

Methods inherited from class java.lang.Object

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

Constructor Detail

XFormUtils

public XFormUtils()

Method Detail

setXFormParserFactory

public static IXFormParserFactory setXFormParserFactory(IXFormParserFactory factory)

getFormFromResource

public static FormDef getFormFromResource(String resource)
                                   throws XFormParser.ParseException

Throws:

XFormParser.ParseException

getFormRaw

public static FormDef getFormRaw(InputStreamReader isr)
                          throws XFormParseException,
                                 IOException,
                                 XFormParser.ParseException

Throws:

XFormParseException

IOException

XFormParser.ParseException

getFormFromInputStream

public static FormDef getFormFromInputStream(InputStream is)
                                      throws XFormParseException,
                                             XFormParser.ParseException

Parses a form with an external secondary instance, and returns a FormDef.

Parameters:

is - the InputStream containing the form

Returns:

a FormDef for the parsed form

Throws:

XFormParseException - if the form can’t be parsed

XFormParser.ParseException

getFormFromInputStream

public static FormDef getFormFromInputStream(InputStream is,
                                             String lastSavedSrc)
                                      throws XFormParser.ParseException

Parameters:

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

See Also:

getFormFromInputStream(InputStream)

getFormFromFormXml

public static FormDef getFormFromFormXml(String formXmlSrc,
                                         String lastSavedSrc)
                                  throws XFormParseException,
                                         XFormParser.ParseException

Parameters:

formXmlSrc - The path to the XForm that is to be parsed

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:

XFormParseException

XFormParser.ParseException

getFormFromSerializedResource

public static FormDef getFormFromSerializedResource(String resource)

getAttributeList

public static List<String> getAttributeList(org.kxml2.kdom.Element e)

getUnusedAttributes

public static List<String> getUnusedAttributes(org.kxml2.kdom.Element e,
                                               List<String> usedAtts)

unusedAttWarning

public static String unusedAttWarning(org.kxml2.kdom.Element e,
                                      List<String> usedAtts)

showUnusedAttributeWarning

public static boolean showUnusedAttributeWarning(org.kxml2.kdom.Element e,
                                                 List<String> usedAtts)

isOutput

public static boolean isOutput(org.kxml2.kdom.Element e)

Is this element an Output tag?

Parameters:

e -

Returns: