org.openestate.io.openimmo

Class OpenImmoUtils

java.lang.Object

org.openestate.io.openimmo.OpenImmoUtils

public class OpenImmoUtils
extends Object

Some helper functions for the OpenImmo-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	OLD_NAMESPACE the old XML target namespace of this format, that was used up to version 1.2
static String	PACKAGE the package, where generated JAXB classes are located
static OpenImmoVersion	VERSION the latest implemented version of this format

Method Summary

Methods

Modifier and Type	Method and Description
static OpenImmoDocument	createDocument(Document doc) Creates a OpenImmoDocument from a Document.
static OpenImmoDocument	createDocument(File xmlFile) Creates a OpenImmoDocument from a File.
static OpenImmoDocument	createDocument(InputStream input) Creates a OpenImmoDocument from an InputStream.
static OpenImmoDocument	createDocument(String xmlString) Creates a OpenImmoDocument 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 Element	createUserDefinedSimplefield(Document doc, String name, String value) Helper method to create a <user_defined_simplefield> element with a "feldname" attribute and a string value.
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 void	initContext(ClassLoader classloader) Intializes the JAXBContext for this format.
static Calendar	parseDate(String value)
static Calendar	parseDateTime(String value)
static Double	parseDecimal(String value)
static String	printDate(Calendar value)
static String	printDateTime(Calendar value)
static String	printDecimal(Double value)

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static final OpenImmoVersion VERSION

the latest implemented version of this format

NAMESPACE

public static final String NAMESPACE

the XML target namespace of this format

See Also:

Constant Field Values

OLD_NAMESPACE

public static final String OLD_NAMESPACE

the old XML target namespace of this format, that was used up to version 1.2

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 OpenImmoDocument createDocument(InputStream input)
                                       throws SAXException,
                                              IOException,
                                              ParserConfigurationException

Creates a OpenImmoDocument 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 OpenImmoDocument createDocument(File xmlFile)
                                       throws SAXException,
                                              IOException,
                                              ParserConfigurationException

Creates a OpenImmoDocument 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 OpenImmoDocument createDocument(String xmlString)
                                       throws SAXException,
                                              IOException,
                                              ParserConfigurationException

Creates a OpenImmoDocument 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 OpenImmoDocument createDocument(Document doc)

Creates a OpenImmoDocument 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

createUserDefinedSimplefield

public static Element createUserDefinedSimplefield(Document doc,
                                   String name,
                                   String value)

Helper method to create a <user_defined_simplefield> element with a "feldname" attribute and a string value.

Parameters:

doc - document, for which the element is created

name - value of the "feldname" attribute in the created element

value - text value of the created element

Returns:

created element

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

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

parseDate

public static Calendar parseDate(String value)

parseDateTime

public static Calendar parseDateTime(String value)

parseDecimal

public static Double parseDecimal(String value)

printDate

public static String printDate(Calendar value)

printDateTime

public static String printDateTime(Calendar value)

printDecimal

public static String printDecimal(Double value)