org.openestate.io.filemaker

Class FilemakerResultDocument

java.lang.Object

org.openestate.io.core.XmlDocument<JavaType>

org.openestate.io.filemaker.FilemakerDocument<FMPXMLRESULT>

org.openestate.io.filemaker.FilemakerResultDocument

public class FilemakerResultDocument
extends FilemakerDocument<FMPXMLRESULT>

XML document from Filemaker with a <FMPXMLRESULT> root element.

Since:

1.0

Author:

Andreas Rudolph

Constructor Summary

Constructors

Constructor and Description
FilemakerResultDocument(Document document) Create from a Document.

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	isReadable(Document doc) Checks, if a Document is readable as a FilemakerResultDocument.
static FilemakerResultDocument	newDocument() Creates an empty FilemakerResultDocument.
static FilemakerResultDocument	newDocument(FMPXMLRESULT xmlResult) Creates a FilemakerResultDocument from a FMPXMLRESULT object.
FilemakerResultMapping	toMapping() Creates a FilemakerResultMapping object from the contained Document.
FMPXMLRESULT	toObject() Creates a FMPXMLRESULT object from the contained Document.

Methods inherited from class org.openestate.io.filemaker.FilemakerDocument

isLayout, isResult

Methods inherited from class org.openestate.io.core.XmlDocument

getDocument, isTextWrittenAsCDATA, prepareDocumentBeforeWritingToXml, setTextWrittenAsCDATA, toXml, toXml, toXml, toXml, toXml, toXml, toXmlString, toXmlString

Methods inherited from class java.lang.Object

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

Constructor Detail

FilemakerResultDocument

public FilemakerResultDocument(Document document)

Create from a Document.

Parameters:

document - the document to create from

Method Detail

isReadable

public static boolean isReadable(Document doc)

Checks, if a Document is readable as a FilemakerResultDocument.

Parameters:

doc - document to check

Returns:

true, if the document is usable, otherwise false

newDocument

public static FilemakerResultDocument newDocument()
                                           throws ParserConfigurationException,
                                                  JAXBException

Creates an empty FilemakerResultDocument.

Returns:

created document

Throws:

ParserConfigurationException - if the parser is not properly configured

JAXBException - if a problem with JAXB occured

newDocument

public static FilemakerResultDocument newDocument(FMPXMLRESULT xmlResult)
                                           throws ParserConfigurationException,
                                                  JAXBException

Creates a FilemakerResultDocument from a FMPXMLRESULT object.

Parameters:

xmlResult - Java object, that represents the <FMPXMLRESULT> root element

Returns:

created document

Throws:

ParserConfigurationException - if the parser is not properly configured

JAXBException - if a problem with JAXB occured

toMapping

public FilemakerResultMapping toMapping()
                                 throws JAXBException

Creates a FilemakerResultMapping object from the contained Document.

Returns:

created mapping, that contains the values from the FMPXMLRESULT

Throws:

JAXBException - if a problem with JAXB occured

toObject

public FMPXMLRESULT toObject()
                      throws JAXBException

Creates a FMPXMLRESULT object from the contained Document.

Specified by:

toObject in class XmlDocument<FMPXMLRESULT>

Returns:

created object, that represents the <FMPXMLRESULT> root element

Throws:

JAXBException - if a problem with JAXB occured