net.datenwerke.eximport

Class ExImportHelperService

java.lang.Object

net.datenwerke.eximport.ExImportHelperService

public class ExImportHelperService
extends java.lang.Object

Helper service used during im and export.

See Also:

ExportService, ImportService

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COLLECTION_VALUE_ELEMENT
static java.lang.String	DOCUMENT_DATA_ELEMENT
static java.lang.String	DOCUMENT_HEAD_DATE_ELEMENT
static java.lang.String	DOCUMENT_HEAD_DESCRIPTION_ELEMENT
static java.lang.String	DOCUMENT_HEAD_ELEMENT
static java.lang.String	DOCUMENT_HEAD_NAME_ELEMENT
static java.lang.String	DOCUMENT_HEAD_USER_ELEMENT
static java.lang.String	DOCUMENT_HEAD_VERSION_ELEMENT
static java.lang.String	DOCUMENT_ROOT_ELEMENT
static java.lang.String	EXIMPORT_XML_NAMESPACE
static java.lang.String	EXIMPORT_XML_NAMESPACE_PREFIX
static java.lang.String	EXPORTED_ITEM_ELEMENT_NAME
static java.lang.String	EXPORTED_PROPERTY_ELEMENT_NAME
static java.lang.String	EXPORTER_BASE_ELEMENT
static java.lang.String	EXPORTER_TYPE
static java.lang.String	IS_COLLECTION_ATTRIBUTE
static java.lang.String	IS_ENCLOSED_ATTRIBUTE
static java.lang.String	IS_NULL_ATTRIBUTE
static java.lang.String	IS_OPTIONAL_REFERENCE
static java.lang.String	NAME_ATTRIBUTE
static java.util.Map<java.lang.String,java.lang.String>	namespaceMap
static java.lang.String	PROPERTY_TYPE
static java.lang.String	REFERENCE_ID
static java.lang.String	TYPE_ATTRIBUTE
static java.lang.String	VALUE_ATTRIBUTE
static java.lang.String	XML_TRUE

Constructor Summary

Constructors

Constructor and Description
ExImportHelperService(ExImportIdService idService)

Method Summary

Modifier and Type	Method and Description
void	addIdAttribute(javax.xml.stream.XMLStreamWriter xsw, java.lang.String entityId) Adds an entityId to the attribute xml:id in the given XMLStreamWriter
void	addNamespaces(javax.xml.stream.XMLStreamWriter xsw)
java.util.Set<java.lang.Class<?>>	getAllowedReferenceTypesFor(java.lang.Object node, java.util.List<Exporter> exporters)
java.lang.String	getIdAttribute(Element el) Returns the id attribute of the given Element
java.lang.String	getIdFor(java.lang.Object object)
java.util.Map	getNamespaceMap()
void	setAttribute(javax.xml.stream.XMLStreamWriter xsw, java.lang.String name, java.lang.String value) Sets the attribute name to the given value
void	setEnclosedAttributes(javax.xml.stream.XMLStreamWriter xsw, Exporter exporter) Sets the XMLStreamWriters EXPORTER_TYPE and IS_ENCLOSED_ATTRIBUTE attributes
void	setExporterType(javax.xml.stream.XMLStreamWriter xsw, java.lang.Class<? extends Exporter> type) Sets the EXPORTER_TYPE attribute of the given XMLStreamWriter
void	setExporterType(javax.xml.stream.XMLStreamWriter xsw, Exporter exporter) Sets the EXPORTER_TYPE attribute of the given XMLStreamWriter
void	setIsCollectionAttribute(javax.xml.stream.XMLStreamWriter xsw, java.lang.Class<?> propertyType) Sets the IS_COLLECTION_ATTRIBUTE attribute of the given XMLStreamWriter to XML_TRUE and the PROPERTY_TYPE to propertyType.getName()
void	setIsNullAttribute(javax.xml.stream.XMLStreamWriter xsw) Sets the IS_NULL_ATTRIBUTE attribute of the given XMLStreamWriter to XML_TRUE
void	setNameAttribute(javax.xml.stream.XMLStreamWriter xsw, java.lang.String name) Sets the NAME_ATTRIBUTE to the given name
void	setReferenceAttributes(javax.xml.stream.XMLStreamWriter xsw, java.lang.String id, java.lang.Class<?> exporterType, boolean optional) Sets the following attributes to the corresponding values: TYPE_ATTRIBUTE <- type.getName() REFERENCE_ID <- id EXPORTER_TYPE <- exporterType.getName() If optional is true: IS_OPTIONAL_REFERENCE <- XML_TRUE
void	setReferenceAttributes(javax.xml.stream.XMLStreamWriter xsw, java.lang.String id, Exporter exporter) Sets the following attributes to the corresponding values: TYPE_ATTRIBUTE <- type.getName() REFERENCE_ID <- id EXPORTER_TYPE <- exporter.getClass().getName()
void	setReferenceAttributes(javax.xml.stream.XMLStreamWriter xsw, java.lang.String id, Exporter exporter, boolean optional) Sets the following attributes to the corresponding values: TYPE_ATTRIBUTE <- type.getName() REFERENCE_ID <- id EXPORTER_TYPE <- exporter.getClass().getName() If optional is true: IS_OPTIONAL_REFERENCE <- XML_TRUE
void	setTypeAttribute(javax.xml.stream.XMLStreamWriter xsw, java.lang.Class<?> type) Sets the TYPE_ATTRIBUTE attribute of the given XMLStreamWriter to the given type
void	setValueAttribute(javax.xml.stream.XMLStreamWriter xsw, java.lang.String value) Sets the VALUE_ATTRIBUTE attribute of the given XMLStreamWriter to the given value
void	writeExImportNamespace(javax.xml.stream.XMLStreamWriter xsw)
XPathContext	xpathContext()
java.lang.String	xqueryNamespaces()

Methods inherited from class java.lang.Object

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

Field Detail

EXIMPORT_XML_NAMESPACE

public static final java.lang.String EXIMPORT_XML_NAMESPACE

See Also:

Constant Field Values

EXIMPORT_XML_NAMESPACE_PREFIX

public static final java.lang.String EXIMPORT_XML_NAMESPACE_PREFIX

See Also:

Constant Field Values

DOCUMENT_ROOT_ELEMENT

public static final java.lang.String DOCUMENT_ROOT_ELEMENT

See Also:

Constant Field Values

DOCUMENT_HEAD_ELEMENT

public static final java.lang.String DOCUMENT_HEAD_ELEMENT

See Also:

Constant Field Values

DOCUMENT_HEAD_USER_ELEMENT

public static final java.lang.String DOCUMENT_HEAD_USER_ELEMENT

See Also:

Constant Field Values

DOCUMENT_HEAD_NAME_ELEMENT

public static final java.lang.String DOCUMENT_HEAD_NAME_ELEMENT

See Also:

Constant Field Values

DOCUMENT_HEAD_DESCRIPTION_ELEMENT

public static final java.lang.String DOCUMENT_HEAD_DESCRIPTION_ELEMENT

See Also:

Constant Field Values

DOCUMENT_HEAD_DATE_ELEMENT

public static final java.lang.String DOCUMENT_HEAD_DATE_ELEMENT

See Also:

Constant Field Values

DOCUMENT_DATA_ELEMENT

public static final java.lang.String DOCUMENT_DATA_ELEMENT

See Also:

Constant Field Values

XML_TRUE

public static final java.lang.String XML_TRUE

See Also:

Constant Field Values

VALUE_ATTRIBUTE

public static final java.lang.String VALUE_ATTRIBUTE

See Also:

Constant Field Values

TYPE_ATTRIBUTE

public static final java.lang.String TYPE_ATTRIBUTE

See Also:

Constant Field Values

IS_NULL_ATTRIBUTE

public static final java.lang.String IS_NULL_ATTRIBUTE

See Also:

Constant Field Values

IS_ENCLOSED_ATTRIBUTE

public static final java.lang.String IS_ENCLOSED_ATTRIBUTE

See Also:

Constant Field Values

NAME_ATTRIBUTE

public static final java.lang.String NAME_ATTRIBUTE

See Also:

Constant Field Values

IS_COLLECTION_ATTRIBUTE

public static final java.lang.String IS_COLLECTION_ATTRIBUTE

See Also:

Constant Field Values

PROPERTY_TYPE

public static final java.lang.String PROPERTY_TYPE

See Also:

Constant Field Values

EXPORTER_TYPE

public static final java.lang.String EXPORTER_TYPE

See Also:

Constant Field Values

REFERENCE_ID

public static final java.lang.String REFERENCE_ID

See Also:

Constant Field Values

IS_OPTIONAL_REFERENCE

public static final java.lang.String IS_OPTIONAL_REFERENCE

See Also:

Constant Field Values

COLLECTION_VALUE_ELEMENT

public static final java.lang.String COLLECTION_VALUE_ELEMENT

See Also:

Constant Field Values

EXPORTED_ITEM_ELEMENT_NAME

public static final java.lang.String EXPORTED_ITEM_ELEMENT_NAME

See Also:

Constant Field Values

EXPORTED_PROPERTY_ELEMENT_NAME

public static final java.lang.String EXPORTED_PROPERTY_ELEMENT_NAME

See Also:

Constant Field Values

EXPORTER_BASE_ELEMENT

public static final java.lang.String EXPORTER_BASE_ELEMENT

See Also:

Constant Field Values

DOCUMENT_HEAD_VERSION_ELEMENT

public static final java.lang.String DOCUMENT_HEAD_VERSION_ELEMENT

See Also:

Constant Field Values

namespaceMap

public static java.util.Map<java.lang.String,java.lang.String> namespaceMap

Constructor Detail

ExImportHelperService

public ExImportHelperService(ExImportIdService idService)

Method Detail

getIdFor

public java.lang.String getIdFor(java.lang.Object object)

setAttribute

public void setAttribute(javax.xml.stream.XMLStreamWriter xsw,
                         java.lang.String name,
                         java.lang.String value)
                  throws javax.xml.stream.XMLStreamException

Sets the attribute name to the given value

Parameters:

xsw - The XMLStreamWriter holding the attribute

name - The name of the attribute

value - The value of the attribute

Throws:

javax.xml.stream.XMLStreamException

addIdAttribute

public void addIdAttribute(javax.xml.stream.XMLStreamWriter xsw,
                           java.lang.String entityId)
                    throws javax.xml.stream.XMLStreamException

Adds an entityId to the attribute xml:id in the given XMLStreamWriter

Parameters:

xsw - The XMLStreamWriter holding the xml:id attribute

entityId - The ID to add

Throws:

javax.xml.stream.XMLStreamException

getIdAttribute

public java.lang.String getIdAttribute(Element el)

Returns the id attribute of the given Element

Parameters:

el - The Element holding the attribute

Returns:

The id attribute of the given Element

setIsNullAttribute

public void setIsNullAttribute(javax.xml.stream.XMLStreamWriter xsw)
                        throws javax.xml.stream.XMLStreamException

Sets the IS_NULL_ATTRIBUTE attribute of the given XMLStreamWriter to XML_TRUE

Parameters:

xsw - The XMLStreamWriter to set the attribute on

Throws:

javax.xml.stream.XMLStreamException

setValueAttribute

public void setValueAttribute(javax.xml.stream.XMLStreamWriter xsw,
                              java.lang.String value)
                       throws javax.xml.stream.XMLStreamException

Sets the VALUE_ATTRIBUTE attribute of the given XMLStreamWriter to the given value

Parameters:

xsw - The XMLStreamWriter to set the attribute on

value - The value to set

Throws:

javax.xml.stream.XMLStreamException

setTypeAttribute

public void setTypeAttribute(javax.xml.stream.XMLStreamWriter xsw,
                             java.lang.Class<?> type)
                      throws javax.xml.stream.XMLStreamException

Sets the TYPE_ATTRIBUTE attribute of the given XMLStreamWriter to the given type

Parameters:

xsw - The XMLStreamWriter to set the attribute on

type - The type to set

Throws:

javax.xml.stream.XMLStreamException

setIsCollectionAttribute

public void setIsCollectionAttribute(javax.xml.stream.XMLStreamWriter xsw,
                                     java.lang.Class<?> propertyType)
                              throws javax.xml.stream.XMLStreamException

Sets the IS_COLLECTION_ATTRIBUTE attribute of the given XMLStreamWriter to XML_TRUE and the PROPERTY_TYPE to propertyType.getName()

Parameters:

xsw - The XMLStreamWriter to set the attributes on

propertyType - The type to set

Throws:

javax.xml.stream.XMLStreamException

setReferenceAttributes

public void setReferenceAttributes(javax.xml.stream.XMLStreamWriter xsw,
                                   java.lang.String id,
                                   Exporter exporter)
                            throws javax.xml.stream.XMLStreamException

Sets the following attributes to the corresponding values:

• TYPE_ATTRIBUTE <- type.getName()
• REFERENCE_ID <- id
• EXPORTER_TYPE <- exporter.getClass().getName()

Parameters:

xsw - The XMLStreamWriter to set the attributes on

id - The ID to set REFERENCE_ID to

exporter - The Exporter to set EXPORTER_TYPE to

Throws:

javax.xml.stream.XMLStreamException

setReferenceAttributes

public void setReferenceAttributes(javax.xml.stream.XMLStreamWriter xsw,
                                   java.lang.String id,
                                   Exporter exporter,
                                   boolean optional)
                            throws javax.xml.stream.XMLStreamException

Sets the following attributes to the corresponding values:

• TYPE_ATTRIBUTE <- type.getName()
• REFERENCE_ID <- id
• EXPORTER_TYPE <- exporter.getClass().getName()

If optional is true:

• IS_OPTIONAL_REFERENCE <- XML_TRUE

Parameters:

xsw - The XMLStreamWriter to set the attributes on

id - The ID to set REFERENCE_ID to

exporter - The Exporter to set EXPORTER_TYPE to

optional - Whether to set IS_OPTIONAL_REFERENCE or not

Throws:

javax.xml.stream.XMLStreamException

setReferenceAttributes

public void setReferenceAttributes(javax.xml.stream.XMLStreamWriter xsw,
                                   java.lang.String id,
                                   java.lang.Class<?> exporterType,
                                   boolean optional)
                            throws javax.xml.stream.XMLStreamException

Sets the following attributes to the corresponding values:

• TYPE_ATTRIBUTE <- type.getName()
• REFERENCE_ID <- id
• EXPORTER_TYPE <- exporterType.getName()

If optional is true:

• IS_OPTIONAL_REFERENCE <- XML_TRUE

Parameters:

xsw - The XMLStreamWriter to set the attributes on

id - The ID to set REFERENCE_ID to

exporterType - The type to set EXPORTER_TYPE to

optional - Whether to set IS_OPTIONAL_REFERENCE or not

Throws:

javax.xml.stream.XMLStreamException

setExporterType

public void setExporterType(javax.xml.stream.XMLStreamWriter xsw,
                            Exporter exporter)
                     throws javax.xml.stream.XMLStreamException

Sets the EXPORTER_TYPE attribute of the given XMLStreamWriter

Parameters:

xsw - The XMLStreamWriter to set the attribute on

exporter - The Exporter to set the EXPORTER_TYPE attribute to

Throws:

javax.xml.stream.XMLStreamException

setExporterType

public void setExporterType(javax.xml.stream.XMLStreamWriter xsw,
                            java.lang.Class<? extends Exporter> type)
                     throws javax.xml.stream.XMLStreamException

Sets the EXPORTER_TYPE attribute of the given XMLStreamWriter

Parameters:

xsw - The XMLStreamWriter to set the attribute on

type - The type to set the EXPORTER_TYPE attribute to

Throws:

javax.xml.stream.XMLStreamException

setEnclosedAttributes

public void setEnclosedAttributes(javax.xml.stream.XMLStreamWriter xsw,
                                  Exporter exporter)
                           throws javax.xml.stream.XMLStreamException

Sets the XMLStreamWriters EXPORTER_TYPE and IS_ENCLOSED_ATTRIBUTE attributes

Parameters:

xsw - The XMLStreamWriter to set the attributes on

exporter - The Exporter to set the EXPORTER_TYPE to

Throws:

javax.xml.stream.XMLStreamException

setNameAttribute

public void setNameAttribute(javax.xml.stream.XMLStreamWriter xsw,
                             java.lang.String name)
                      throws javax.xml.stream.XMLStreamException

Sets the NAME_ATTRIBUTE to the given name

Parameters:

xsw - The XMLStreamWriter to set the attribute on

name - The name to set the NAME_ATTRIBUTE to

Throws:

javax.xml.stream.XMLStreamException

addNamespaces

public void addNamespaces(javax.xml.stream.XMLStreamWriter xsw)
                   throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

writeExImportNamespace

public void writeExImportNamespace(javax.xml.stream.XMLStreamWriter xsw)
                            throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

getNamespaceMap

public java.util.Map getNamespaceMap()

xqueryNamespaces

public java.lang.String xqueryNamespaces()

xpathContext

public XPathContext xpathContext()

getAllowedReferenceTypesFor

public java.util.Set<java.lang.Class<?>> getAllowedReferenceTypesFor(java.lang.Object node,
                                                                     java.util.List<Exporter> exporters)