org.openestate.io.trovit

Class TrovitUtils

java.lang.Object

org.openestate.io.trovit.TrovitUtils

public class TrovitUtils
extends Object

Some helper functions for the Trovit-XML format.

Since:

1.0

Author:

Andreas Rudolph

Field Summary

Fields

Modifier and Type	Field and Description
static ObjectFactory	FACTORY the factory for creation of JAXB objects
static String	NAMESPACE the XML target namespace of this format
static String	PACKAGE the package, where generated JAXB classes are located

Method Summary

Methods

Modifier and Type	Method and Description
static TrovitDocument	createDocument(Document doc) Creates a TrovitDocument from a Document.
static TrovitDocument	createDocument(File xmlFile) Creates a TrovitDocument from a File.
static TrovitDocument	createDocument(InputStream input) Creates a TrovitDocument from an InputStream.
static TrovitDocument	createDocument(String xmlString) Creates a TrovitDocument from a String.
static Marshaller	createMarshaller() Creates a Marshaller to write JAXB objects into XML.
static Marshaller	createMarshaller(String encoding, boolean formatted) Creates a Marshaller to write JAXB objects into XML.
static Unmarshaller	createUnmarshaller() Creates a Unmarshaller to read JAXB objects from XML.
static JAXBContext	getContext() Returns the JAXBContext for this format.
static DateFormat	getDateFormat() Returns the preferred date format for this format.
static ObjectFactory	getFactory() Returns the ObjectFactory for this format.
static DateFormat	getTimeFormat() Returns the preferred time format for this format.
static void	initContext(ClassLoader classloader) Intializes the JAXBContext for this format.
static Action	parseAction(String value)
static Boolean	parseBool(String value)
static Calendar	parseDate(String value)
static BigDecimal	parseFloat(String value)
static BigInteger	parseInt(String value)
static IntBool	parseIntBool(String value)
static BigInteger	parseLong(String value)
static PriceInterval	parsePriceInterval(String value)
static BigDecimal	parsePriceValue(String value)
static String	parseString100(String value)
static String	parseString255(String value)
static Calendar	parseTime(String value)
static Unit	parseUnit(String value)
static Integer	parseYear(String value)
static String	printAction(Action value)
static String	printBool(Boolean value)
static String	printDate(Calendar value)
static String	printFloat(BigDecimal value)
static String	printInt(BigInteger value)
static String	printIntBool(IntBool value)
static String	printLong(BigInteger value)
static String	printPriceInterval(PriceInterval value)
static String	printPriceValue(BigDecimal value)
static String	printString100(String value)
static String	printString255(String value)
static String	printTime(Calendar value)
static String	printUnit(Unit value)
static String	printYear(Integer value)

Methods inherited from class java.lang.Object

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

Field Detail

NAMESPACE

public static final String NAMESPACE

the XML target namespace of this format

See Also:

Constant Field Values

PACKAGE

public static final String PACKAGE

the package, where generated JAXB classes are located

See Also:

Constant Field Values

FACTORY

public static final ObjectFactory FACTORY

the factory for creation of JAXB objects

Method Detail

createDocument

public static TrovitDocument createDocument(InputStream input)
                                     throws SAXException,
                                            IOException,
                                            ParserConfigurationException

Creates a TrovitDocument from an InputStream.

Parameters:

input - XML input

Returns:

created document or null, of the document is not supported by this format

Throws:

SAXException - if XML is invalid

IOException - if reading failed

ParserConfigurationException - if the parser is not properly configured

createDocument

public static TrovitDocument createDocument(File xmlFile)
                                     throws SAXException,
                                            IOException,
                                            ParserConfigurationException

Creates a TrovitDocument from a File.

Parameters:

xmlFile - XML file

Returns:

created document or null, of the document is not supported by this format

Throws:

SAXException - if XML is invalid

IOException - if reading failed

ParserConfigurationException - if the parser is not properly configured

createDocument

public static TrovitDocument createDocument(String xmlString)
                                     throws SAXException,
                                            IOException,
                                            ParserConfigurationException

Creates a TrovitDocument from a String.

Parameters:

xmlString - XML string

Returns:

created document or null, of the document is not supported by this format

Throws:

SAXException - if XML is invalid

IOException - if reading failed

ParserConfigurationException - if the parser is not properly configured

createDocument

public static TrovitDocument createDocument(Document doc)

Creates a TrovitDocument from a Document.

Parameters:

doc - XML document

Returns:

created document or null, of the document is not supported by this format

createMarshaller

public static Marshaller createMarshaller()
                                   throws JAXBException

Creates a Marshaller to write JAXB objects into XML.

Returns:

created marshaller

Throws:

JAXBException - if a problem with JAXB occured

createMarshaller

public static Marshaller createMarshaller(String encoding,
                          boolean formatted)
                                   throws JAXBException

Creates a Marshaller to write JAXB objects into XML.

Parameters:

encoding - encoding of written XML

formatted - if written XML is pretty printed

Returns:

created marshaller

Throws:

JAXBException - if a problem with JAXB occured

createUnmarshaller

public static Unmarshaller createUnmarshaller()
                                       throws JAXBException

Creates a Unmarshaller to read JAXB objects from XML.

Returns:

created unmarshaller

Throws:

JAXBException - if a problem with JAXB occured

getContext

public static JAXBContext getContext()
                              throws JAXBException

Returns the JAXBContext for this format.

Returns:

context

Throws:

JAXBException - if a problem with JAXB occured

getDateFormat

public static DateFormat getDateFormat()

Returns the preferred date format for this format.

Returns:

date format

getFactory

public static ObjectFactory getFactory()

Returns the ObjectFactory for this format.

Returns:

object factory

getTimeFormat

public static DateFormat getTimeFormat()

Returns the preferred time format for this format.

Returns:

date format

initContext

public static void initContext(ClassLoader classloader)
                        throws JAXBException

Intializes the JAXBContext for this format.

Parameters:

classloader - the classloader to load the generated JAXB classes with

Throws:

JAXBException - if a problem with JAXB occured

parseAction

public static Action parseAction(String value)

parseBool

public static Boolean parseBool(String value)

parseDate

public static Calendar parseDate(String value)

parseFloat

public static BigDecimal parseFloat(String value)

parseInt

public static BigInteger parseInt(String value)

parseIntBool

public static IntBool parseIntBool(String value)

parseLong

public static BigInteger parseLong(String value)

parsePriceInterval

public static PriceInterval parsePriceInterval(String value)

parsePriceValue

public static BigDecimal parsePriceValue(String value)

parseString100

public static String parseString100(String value)

parseString255

public static String parseString255(String value)

parseTime

public static Calendar parseTime(String value)

parseUnit

public static Unit parseUnit(String value)

parseYear

public static Integer parseYear(String value)

printAction

public static String printAction(Action value)

printBool

public static String printBool(Boolean value)

printDate

public static String printDate(Calendar value)

printFloat

public static String printFloat(BigDecimal value)

printInt

public static String printInt(BigInteger value)

printIntBool

public static String printIntBool(IntBool value)

printLong

public static String printLong(BigInteger value)

printPriceInterval

public static String printPriceInterval(PriceInterval value)

printPriceValue

public static String printPriceValue(BigDecimal value)

printString100

public static String printString100(String value)

printString255

public static String printString255(String value)

printTime

public static String printTime(Calendar value)

printUnit

public static String printUnit(Unit value)

printYear

public static String printYear(Integer value)