org.openestate.io.kyero

Class KyeroUtils

java.lang.Object

org.openestate.io.kyero.KyeroUtils

public class KyeroUtils
extends Object

Some helper functions for the Kyero-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
static KyeroVersion	VERSION the latest implemented version of this format

Method Summary

Methods

Modifier and Type	Method and Description
static KyeroDocument	createDocument(Document doc) Creates a KyeroDocument from a Document.
static KyeroDocument	createDocument(File xmlFile) Creates a KyeroDocument from a File.
static KyeroDocument	createDocument(InputStream input) Creates a KyeroDocument from an InputStream.
static KyeroDocument	createDocument(String xmlString) Creates a KyeroDocument 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 DateFormat	getDateFormatAlternative() Returns the alternative 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 boolean	isValidFeedVersionType(String value)
static boolean	isValidIdType(String value)
static boolean	isValidImageAttributeType(Integer value)
static boolean	isValidImageUrlType(URL value)
static boolean	isValidRefType(String value)
static boolean	isValidRequiredType(String value)
static boolean	isValidTypeDataType(String value)
static boolean	isValidUrlDataType(URL value)
static Boolean	parseBoolType(String value)
static Calendar	parseDateType(String value)
static BigDecimal	parseDecimal(String value)
static String	parseFeedVersionType(String value)
static String	parseIdType(String value)
static Integer	parseImageAttributeType(String value)
static URL	parseImageUrlType(String value)
static BigInteger	parseInteger(String value)
static String	parseLocationType(String value)
static BigInteger	parseNonNegativeInteger(String value)
static Long	parsePriceType(String value)
static String	parseRefType(String value)
static String	parseRequiredType(String value)
static String	parseTypeDataType(String value)
static URL	parseUrlDataType(String value)
static String	printBoolType(Boolean value)
static String	printDateType(Calendar value)
static String	printDecimal(BigDecimal value)
static String	printFeedVersionType(String value)
static String	printIdType(String value)
static String	printImageAttributeType(Integer value)
static String	printImageUrlType(URL value)
static String	printInteger(BigInteger value)
static String	printLocationType(String value)
static String	printNonNegativeInteger(BigInteger value)
static String	printPriceType(Long value)
static String	printRefType(String value)
static String	printRequiredType(String value)
static String	printTypeDataType(String value)
static String	printUrlDataType(URL 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 KyeroVersion 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

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

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

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

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

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

getDateFormatAlternative

public static DateFormat getDateFormatAlternative()

Returns the alternative 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

isValidFeedVersionType

public static boolean isValidFeedVersionType(String value)

isValidIdType

public static boolean isValidIdType(String value)

isValidImageAttributeType

public static boolean isValidImageAttributeType(Integer value)

isValidImageUrlType

public static boolean isValidImageUrlType(URL value)

isValidRefType

public static boolean isValidRefType(String value)

isValidRequiredType

public static boolean isValidRequiredType(String value)

isValidTypeDataType

public static boolean isValidTypeDataType(String value)

isValidUrlDataType

public static boolean isValidUrlDataType(URL value)

parseBoolType

public static Boolean parseBoolType(String value)

parseDateType

public static Calendar parseDateType(String value)

parseDecimal

public static BigDecimal parseDecimal(String value)

parseFeedVersionType

public static String parseFeedVersionType(String value)

parseIdType

public static String parseIdType(String value)

parseImageAttributeType

public static Integer parseImageAttributeType(String value)

parseImageUrlType

public static URL parseImageUrlType(String value)

parseInteger

public static BigInteger parseInteger(String value)

parseLocationType

public static String parseLocationType(String value)

parseNonNegativeInteger

public static BigInteger parseNonNegativeInteger(String value)

parsePriceType

public static Long parsePriceType(String value)

parseRefType

public static String parseRefType(String value)

parseRequiredType

public static String parseRequiredType(String value)

parseTypeDataType

public static String parseTypeDataType(String value)

parseUrlDataType

public static URL parseUrlDataType(String value)

printBoolType

public static String printBoolType(Boolean value)

printDateType

public static String printDateType(Calendar value)

printDecimal

public static String printDecimal(BigDecimal value)

printFeedVersionType

public static String printFeedVersionType(String value)

printIdType

public static String printIdType(String value)

printImageAttributeType

public static String printImageAttributeType(Integer value)

printImageUrlType

public static String printImageUrlType(URL value)

printInteger

public static String printInteger(BigInteger value)

printLocationType

public static String printLocationType(String value)

printNonNegativeInteger

public static String printNonNegativeInteger(BigInteger value)

printPriceType

public static String printPriceType(Long value)

printRefType

public static String printRefType(String value)

printRequiredType

public static String printRequiredType(String value)

printTypeDataType

public static String printTypeDataType(String value)

printUrlDataType

public static String printUrlDataType(URL value)