TrovitUtils (OpenEstate-IO 1.4 API)

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

All Methods Static Methods Concrete 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 ObjectFactory`	`getFactory()` Returns the `ObjectFactory` for this format.
`static void`	`initContext(ClassLoader classloader)` Initializes the `JAXBContext` for this format.
`static AreaUnitValue`	`parseAreaUnitValue(String value)` Read a `AreaUnitValue` value from XML.
`static Boolean`	`parseBooleanValue(String value)` Read a `Boolean` value from XML.
`static String`	`parseContentValue(String value)` Read a `String` value from XML for description.
`static String`	`parseCountryValue(String value)` Read a `String` value from XML for a country code.
`static Calendar`	`parseDateValue(String value)` Read a `Calendar` value from XML.
`static BigInteger`	`parseFloorAreaValue(String value)` Read a `BigInteger` value from XML for a floor area.
`static ForeclosureTypeValue`	`parseForeclosureTypeValue(String value)` Read a `ForeclosureTypeValue` value from XML.
`static BigDecimal`	`parseLatitudeValue(String value)` Read a `BigDecimal` value from XML with a valid latitude range.
`static BigDecimal`	`parseLongitudeValue(String value)` Read a `BigDecimal` value from XML with a valid longitude range.
`static OrientationValue`	`parseOrientationValue(String value)` Read a `OrientationValue` value from XML.
`static BigInteger`	`parsePlotAreaValue(String value)` Read a `BigInteger` value from XML for a plot area.
`static Currency`	`parsePriceCurrencyValue(String value)` Read a `Currency` value from XML.
`static PricePeriodValue`	`parsePricePeriodValue(String value)` Read a `PricePeriodValue` value from XML.
`static BigDecimal`	`parsePriceValue(String value)` Read a `BigDecimal` value from XML for a price.
`static BigDecimal`	`parseRoomsValue(String value)` Read a `BigDecimal` value from XML for a number of rooms.
`static TypeValue`	`parseTypeValue(String value)` Read a `TypeValue` value from XML.
`static URI`	`parseUriValue(String value)` Read an `URI` value from XML.
`static BigInteger`	`parseYearValue(String value)` Read a `BigInteger` value from XML for a year number.
`static String`	`printAreaUnitValue(AreaUnitValue value)` Write a `AreaUnitValue` value into XML output.
`static String`	`printBooleanValue(Boolean value)` Write a `Boolean` value into XML output.
`static String`	`printContentValue(String value)` Write a `String` value for a description into XML output.
`static String`	`printCountryValue(String value)` Write a `String` value for a country code into XML output.
`static String`	`printDateValue(Calendar value)` Write a `Calendar` value into XML output.
`static String`	`printFloorAreaValue(BigInteger value)` Write a `BigInteger` value into XML output for a floor area.
`static String`	`printForeclosureTypeValue(ForeclosureTypeValue value)` Write a `ForeclosureTypeValue` value into XML output.
`static String`	`printLatitudeValue(BigDecimal value)` Write a `BigDecimal` value into XML output with a valid latitude range.
`static String`	`printLongitudeValue(BigDecimal value)` Write a `BigDecimal` value into XML output with a valid longitude range.
`static String`	`printOrientationValue(OrientationValue value)` Write a `OrientationValue` value into XML output.
`static String`	`printPlotAreaValue(BigInteger value)` Write a `BigInteger` value into XML output for a plot area.
`static String`	`printPriceCurrencyValue(Currency value)` Write a `Currency` value into XML output.
`static String`	`printPricePeriodValue(PricePeriodValue value)` Write a `PricePeriodValue` value into XML output.
`static String`	`printPriceValue(BigDecimal value)` Write a `BigDecimal` value into XML output for a price.
`static String`	`printRoomsValue(BigDecimal value)` Write a `BigDecimal` value into XML output for a room number.
`static String`	`printTypeValue(TypeValue value)` Write a `TypeValue` value into XML output.
`static String`	`printUriValue(URI value)` Write an `URI` value into XML output.
`static String`	`printYearValue(BigInteger value)` Write a `BigInteger` value into XML output for a year number.

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 occurred
  - 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 occurred
  - 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 occurred
  - getContext
```
public static JAXBContext getContext()
                              throws JAXBException
```
    Returns the JAXBContext for this format.
    
    Returns:
    
    context
    
    Throws:
    
    JAXBException - if a problem with JAXB occurred
  - getFactory
```
public static ObjectFactory getFactory()
```
    Returns the ObjectFactory for this format.
    
    Returns:
    
    object factory
  - initContext
```
public static void initContext(ClassLoader classloader)
                        throws JAXBException
```
    Initializes the JAXBContext for this format.
    
    Parameters:
    
    classloader - the classloader to load the generated JAXB classes with
    
    Throws:
    
    JAXBException - if a problem with JAXB occurred
  - parseAreaUnitValue
```
public static AreaUnitValue parseAreaUnitValue(String value)
```
    Read a AreaUnitValue value from XML.
    
    Parameters:
    
    value - XML string
    
    Returns:
    
    parsed value or null, if the value is invalid
  - parseBooleanValue
```
public static Boolean parseBooleanValue(String value)
```
    Read a Boolean value from XML.
    
    Parameters:
    
    value - XML string
    
    Returns:
    
    parsed value or null, if the value is invalid
  - parseContentValue
```
public static String parseContentValue(String value)
```
    Read a String value from XML for description.
    
    Parameters:
    
    value - XML string
    
    Returns:
    
    parsed value or null, if the value is invalid
  - parseCountryValue
```
public static String parseCountryValue(String value)
```
    Read a String value from XML for a country code.
    
    Parameters:
    
    value - XML string
    
    Returns:
    
    parsed value or null, if the value is invalid
  - parseDateValue
```
public static Calendar parseDateValue(String value)
```
    Read a Calendar value from XML.
    
    Parameters:
    
    value - XML string
    
    Returns:
    
    parsed value or null, if the value is invalid
  - parseFloorAreaValue
```
public static BigInteger parseFloorAreaValue(String value)
```
    Read a BigInteger value from XML for a floor area.
    
    Parameters:
    
    value - XML string
    
    Returns:
    
    parsed value or null, if the value is invalid
  - parseForeclosureTypeValue
```
public static ForeclosureTypeValue parseForeclosureTypeValue(String value)
```
    Read a ForeclosureTypeValue value from XML.
    
    Parameters:
    
    value - XML string
    
    Returns:
    
    parsed value or null, if the value is invalid
  - parseLatitudeValue
```
public static BigDecimal parseLatitudeValue(String value)
```
    Read a BigDecimal value from XML with a valid latitude range.
    
    Parameters:
    
    value - XML string
    
    Returns:
    
    parsed value or null, if the value is invalid
  - parseLongitudeValue
```
public static BigDecimal parseLongitudeValue(String value)
```
    Read a BigDecimal value from XML with a valid longitude range.
    
    Parameters:
    
    value - XML string
    
    Returns:
    
    parsed value or null, if the value is invalid
  - parseOrientationValue
```
public static OrientationValue parseOrientationValue(String value)
```
    Read a OrientationValue value from XML.
    
    Parameters:
    
    value - XML string
    
    Returns:
    
    parsed value or null, if the value is invalid
  - parsePlotAreaValue
```
public static BigInteger parsePlotAreaValue(String value)
```
    Read a BigInteger value from XML for a plot area.
    
    Parameters:
    
    value - XML string
    
    Returns:
    
    parsed value or null, if the value is invalid
  - parsePriceCurrencyValue
```
public static Currency parsePriceCurrencyValue(String value)
```
    Read a Currency value from XML.
    
    Parameters:
    
    value - XML string
    
    Returns:
    
    parsed value or null, if the value is invalid
  - parsePricePeriodValue
```
public static PricePeriodValue parsePricePeriodValue(String value)
```
    Read a PricePeriodValue value from XML.
    
    Parameters:
    
    value - XML string
    
    Returns:
    
    parsed value or null, if the value is invalid
  - parsePriceValue
```
public static BigDecimal parsePriceValue(String value)
```
    Read a BigDecimal value from XML for a price.
    
    Parameters:
    
    value - XML string
    
    Returns:
    
    parsed value or null, if the value is invalid
  - parseRoomsValue
```
public static BigDecimal parseRoomsValue(String value)
```
    Read a BigDecimal value from XML for a number of rooms.
    
    Parameters:
    
    value - XML string
    
    Returns:
    
    parsed value or null, if the value is invalid
  - parseUriValue
```
public static URI parseUriValue(String value)
```
    Read an URI value from XML.
    
    Parameters:
    
    value - XML string
    
    Returns:
    
    parsed value or null, if the value is invalid
  - parseTypeValue
```
public static TypeValue parseTypeValue(String value)
```
    Read a TypeValue value from XML.
    
    Parameters:
    
    value - XML string
    
    Returns:
    
    parsed value or null, if the value is invalid
  - parseYearValue
```
public static BigInteger parseYearValue(String value)
```
    Read a BigInteger value from XML for a year number.
    
    Parameters:
    
    value - XML string
    
    Returns:
    
    parsed value or null, if the value is invalid
  - printAreaUnitValue
```
public static String printAreaUnitValue(AreaUnitValue value)
```
    Write a AreaUnitValue value into XML output.
    
    Parameters:
    
    value - value to write
    
    Returns:
    
    XML string
    
    Throws:
    
    IllegalArgumentException - if a validation error occurred
  - printBooleanValue
```
public static String printBooleanValue(Boolean value)
```
    Write a Boolean value into XML output.
    
    Parameters:
    
    value - value to write
    
    Returns:
    
    XML string
    
    Throws:
    
    IllegalArgumentException - if a validation error occurred
  - printContentValue
```
public static String printContentValue(String value)
```
    Write a String value for a description into XML output.
    The description must contain at least 30 characters.
    
    Parameters:
    
    value - value to write
    
    Returns:
    
    XML string
    
    Throws:
    
    IllegalArgumentException - if a validation error occurred
  - printCountryValue
```
public static String printCountryValue(String value)
```
    Write a String value for a country code into XML output.
    The country has to be represendet by a ISO-Code wirh two or three characters.
    
    Parameters:
    
    value - value to write
    
    Returns:
    
    XML string
    
    Throws:
    
    IllegalArgumentException - if a validation error occurred
  - printDateValue
```
public static String printDateValue(Calendar value)
```
    Write a Calendar value into XML output.
    
    Parameters:
    
    value - value to write
    
    Returns:
    
    XML string
    
    Throws:
    
    IllegalArgumentException - if a validation error occurred
  - printFloorAreaValue
```
public static String printFloorAreaValue(BigInteger value)
```
    Write a BigInteger value into XML output for a floor area.
    
    Parameters:
    
    value - value to write
    
    Returns:
    
    XML string
    
    Throws:
    
    IllegalArgumentException - if a validation error occurred
  - printForeclosureTypeValue
```
public static String printForeclosureTypeValue(ForeclosureTypeValue value)
```
    Write a ForeclosureTypeValue value into XML output.
    
    Parameters:
    
    value - value to write
    
    Returns:
    
    XML string
    
    Throws:
    
    IllegalArgumentException - if a validation error occurred
  - printLatitudeValue
```
public static String printLatitudeValue(BigDecimal value)
```
    Write a BigDecimal value into XML output with a valid latitude range.
    
    Parameters:
    
    value - value to write
    
    Returns:
    
    XML string
    
    Throws:
    
    IllegalArgumentException - if a validation error occurred
  - printLongitudeValue
```
public static String printLongitudeValue(BigDecimal value)
```
    Write a BigDecimal value into XML output with a valid longitude range.
    
    Parameters:
    
    value - value to write
    
    Returns:
    
    XML string
    
    Throws:
    
    IllegalArgumentException - if a validation error occurred
  - printOrientationValue
```
public static String printOrientationValue(OrientationValue value)
```
    Write a OrientationValue value into XML output.
    
    Parameters:
    
    value - value to write
    
    Returns:
    
    XML string
    
    Throws:
    
    IllegalArgumentException - if a validation error occurred
  - printPlotAreaValue
```
public static String printPlotAreaValue(BigInteger value)
```
    Write a BigInteger value into XML output for a plot area.
    
    Parameters:
    
    value - value to write
    
    Returns:
    
    XML string
    
    Throws:
    
    IllegalArgumentException - if a validation error occurred
  - printPriceCurrencyValue
```
public static String printPriceCurrencyValue(Currency value)
```
    Write a Currency value into XML output.
    
    Parameters:
    
    value - value to write
    
    Returns:
    
    XML string
    
    Throws:
    
    IllegalArgumentException - if a validation error occurred
  - printPricePeriodValue
```
public static String printPricePeriodValue(PricePeriodValue value)
```
    Write a PricePeriodValue value into XML output.
    
    Parameters:
    
    value - value to write
    
    Returns:
    
    XML string
    
    Throws:
    
    IllegalArgumentException - if a validation error occurred
  - printPriceValue
```
public static String printPriceValue(BigDecimal value)
```
    Write a BigDecimal value into XML output for a price.
    
    Parameters:
    
    value - value to write
    
    Returns:
    
    XML string
    
    Throws:
    
    IllegalArgumentException - if a validation error occurred
  - printRoomsValue
```
public static String printRoomsValue(BigDecimal value)
```
    Write a BigDecimal value into XML output for a room number.
    
    Parameters:
    
    value - value to write
    
    Returns:
    
    XML string
    
    Throws:
    
    IllegalArgumentException - if a validation error occurred
  - printTypeValue
```
public static String printTypeValue(TypeValue value)
```
    Write a TypeValue value into XML output.
    
    Parameters:
    
    value - value to write
    
    Returns:
    
    XML string
    
    Throws:
    
    IllegalArgumentException - if a validation error occurred
  - printUriValue
```
public static String printUriValue(URI value)
```
    Write an URI value into XML output.
    
    Parameters:
    
    value - value to write
    
    Returns:
    
    XML string
    
    Throws:
    
    IllegalArgumentException - if a validation error occurred
  - printYearValue
```
public static String printYearValue(BigInteger value)
```
    Write a BigInteger value into XML output for a year number.
    
    Parameters:
    
    value - value to write
    
    Returns:
    
    XML string
    
    Throws:
    
    IllegalArgumentException - if a validation error occurred

Class TrovitUtils

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NAMESPACE

PACKAGE

FACTORY

Method Detail

createDocument

createDocument

createDocument

createDocument

createMarshaller

createMarshaller

createUnmarshaller

getContext

getFactory

initContext

parseAreaUnitValue

parseBooleanValue

parseContentValue

parseCountryValue

parseDateValue

parseFloorAreaValue

parseForeclosureTypeValue

parseLatitudeValue

parseLongitudeValue

parseOrientationValue

parsePlotAreaValue

parsePriceCurrencyValue

parsePricePeriodValue

parsePriceValue

parseRoomsValue

parseUriValue

parseTypeValue

parseYearValue

printAreaUnitValue

printBooleanValue

printContentValue

printCountryValue

printDateValue

printFloorAreaValue

printForeclosureTypeValue

printLatitudeValue

printLongitudeValue

printOrientationValue

printPlotAreaValue

printPriceCurrencyValue

printPricePeriodValue

printPriceValue

printRoomsValue

printTypeValue

printUriValue

printYearValue