Package net.datenwerke.eximport

Class ExImportHelperService

java.lang.Object

net.datenwerke.eximport.ExImportHelperService

public class ExImportHelperService
extends Object

Helper service used during im and export.

See Also:

• ExportService
• ImportService

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
ExImportHelperService(ExImportIdService idService)

Method Summary

Modifier and Type	Method	Description
void	addIdAttribute(XMLStreamWriter xsw, String entityId)	Adds an entityId to the attribute xml:id in the given XMLStreamWriter
void	addNamespaces(XMLStreamWriter xsw)
Set<Class<?>>	getAllowedReferenceTypesFor(Object node, List<Exporter> exporters)
String	getIdAttribute(Element el)	Returns the id attribute of the given invalid reference Element
String	getIdFor(Object object)
Map	getNamespaceMap()
void	setAttribute(XMLStreamWriter xsw, String name, String value)	Sets the attribute name to the given value
void	setEnclosedAttributes(XMLStreamWriter xsw, Exporter exporter)	Sets the XMLStreamWriters EXPORTER_TYPE and IS_ENCLOSED_ATTRIBUTE attributes
void	setExporterType(XMLStreamWriter xsw, Class<? extends Exporter> type)	Sets the EXPORTER_TYPE attribute of the given XMLStreamWriter
void	setExporterType(XMLStreamWriter xsw, Exporter exporter)	Sets the EXPORTER_TYPE attribute of the given XMLStreamWriter
void	setIsCollectionAttribute(XMLStreamWriter xsw, Class<?> propertyType)	Sets the IS_COLLECTION_ATTRIBUTE attribute of the given XMLStreamWriter to XML_TRUE and the PROPERTY_TYPE to propertyType.getName()
void	setIsNullAttribute(XMLStreamWriter xsw)	Sets the IS_NULL_ATTRIBUTE attribute of the given XMLStreamWriter to XML_TRUE
void	setNameAttribute(XMLStreamWriter xsw, String name)	Sets the NAME_ATTRIBUTE to the given name
void	setReferenceAttributes(XMLStreamWriter xsw, String id, 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(XMLStreamWriter xsw, 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(XMLStreamWriter xsw, 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(XMLStreamWriter xsw, Class<?> type)	Sets the TYPE_ATTRIBUTE attribute of the given XMLStreamWriter to the given type
void	setValueAttribute(XMLStreamWriter xsw, String value)	Sets the VALUE_ATTRIBUTE attribute of the given XMLStreamWriter to the given value
void	writeExImportNamespace(XMLStreamWriter xsw)
XPathContext	xpathContext()
String	xqueryNamespaces()

Methods inherited from class java.lang.Object

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

Field Details

EXIMPORT_XML_NAMESPACE

public static final String EXIMPORT_XML_NAMESPACE

See Also:

• Constant Field Values

EXIMPORT_XML_NAMESPACE_PREFIX

public static final String EXIMPORT_XML_NAMESPACE_PREFIX

See Also:

• Constant Field Values

DOCUMENT_ROOT_ELEMENT

public static final String DOCUMENT_ROOT_ELEMENT

See Also:

• Constant Field Values

DOCUMENT_HEAD_ELEMENT

public static final String DOCUMENT_HEAD_ELEMENT

See Also:

• Constant Field Values

DOCUMENT_HEAD_USER_ELEMENT

public static final String DOCUMENT_HEAD_USER_ELEMENT

See Also:

• Constant Field Values

DOCUMENT_HEAD_NAME_ELEMENT

public static final String DOCUMENT_HEAD_NAME_ELEMENT

See Also:

• Constant Field Values

DOCUMENT_HEAD_DESCRIPTION_ELEMENT

public static final String DOCUMENT_HEAD_DESCRIPTION_ELEMENT

See Also:

• Constant Field Values

DOCUMENT_HEAD_DATE_ELEMENT

public static final String DOCUMENT_HEAD_DATE_ELEMENT

See Also:

• Constant Field Values

DOCUMENT_DATA_ELEMENT

public static final String DOCUMENT_DATA_ELEMENT

See Also:

• Constant Field Values

XML_TRUE

public static final String XML_TRUE

See Also:

• Constant Field Values

VALUE_ATTRIBUTE

public static final String VALUE_ATTRIBUTE

See Also:

• Constant Field Values

TYPE_ATTRIBUTE

public static final String TYPE_ATTRIBUTE

See Also:

• Constant Field Values

IS_NULL_ATTRIBUTE

public static final String IS_NULL_ATTRIBUTE

See Also:

• Constant Field Values

IS_ENCLOSED_ATTRIBUTE

public static final String IS_ENCLOSED_ATTRIBUTE

See Also:

• Constant Field Values

NAME_ATTRIBUTE

public static final String NAME_ATTRIBUTE

See Also:

• Constant Field Values

IS_COLLECTION_ATTRIBUTE

public static final String IS_COLLECTION_ATTRIBUTE

See Also:

• Constant Field Values

PROPERTY_TYPE

public static final String PROPERTY_TYPE

See Also:

• Constant Field Values

EXPORTER_TYPE

public static final String EXPORTER_TYPE

See Also:

• Constant Field Values

REFERENCE_ID

public static final String REFERENCE_ID

See Also:

• Constant Field Values

IS_OPTIONAL_REFERENCE

public static final String IS_OPTIONAL_REFERENCE

See Also:

• Constant Field Values

COLLECTION_VALUE_ELEMENT

public static final String COLLECTION_VALUE_ELEMENT

See Also:

• Constant Field Values

EXPORTED_ITEM_ELEMENT_NAME

public static final String EXPORTED_ITEM_ELEMENT_NAME

See Also:

• Constant Field Values

EXPORTED_PROPERTY_ELEMENT_NAME

public static final String EXPORTED_PROPERTY_ELEMENT_NAME

See Also:

• Constant Field Values

EXPORTER_BASE_ELEMENT

public static final String EXPORTER_BASE_ELEMENT

See Also:

• Constant Field Values

DOCUMENT_HEAD_VERSION_ELEMENT

public static final String DOCUMENT_HEAD_VERSION_ELEMENT

See Also:

• Constant Field Values

namespaceMap

public static Map<String,String> namespaceMap

Constructor Details

ExImportHelperService

public ExImportHelperService(ExImportIdService idService)

Method Details

getIdFor

public String getIdFor(Object object)

setAttribute

public void setAttribute(XMLStreamWriter xsw,
 String name,
 String value)
                  throws 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:

XMLStreamException

addIdAttribute

public void addIdAttribute(XMLStreamWriter xsw,
 String entityId)
                    throws 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:

XMLStreamException

getIdAttribute

public String getIdAttribute(Element el)

Returns the id attribute of the given

invalid reference

Element

Parameters:

el - The

invalid reference

Element

holding the attribute

Returns:

The id attribute of the given

invalid reference

Element

setIsNullAttribute

public void setIsNullAttribute(XMLStreamWriter xsw)
                        throws XMLStreamException

Sets the IS_NULL_ATTRIBUTE attribute of the given XMLStreamWriter to XML_TRUE

Parameters:

xsw - The XMLStreamWriter to set the attribute on

Throws:

XMLStreamException

setValueAttribute

public void setValueAttribute(XMLStreamWriter xsw,
 String value)
                       throws 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:

XMLStreamException

setTypeAttribute

public void setTypeAttribute(XMLStreamWriter xsw,
 Class<?> type)
                      throws 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:

XMLStreamException

setIsCollectionAttribute

public void setIsCollectionAttribute(XMLStreamWriter xsw,
 Class<?> propertyType)
                              throws 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:

XMLStreamException

setReferenceAttributes

public void setReferenceAttributes(XMLStreamWriter xsw,
 String id,
 Exporter exporter)
                            throws 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:

XMLStreamException

setReferenceAttributes

public void setReferenceAttributes(XMLStreamWriter xsw,
 String id,
 Exporter exporter,
 boolean optional)
                            throws 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:

XMLStreamException

setReferenceAttributes

public void setReferenceAttributes(XMLStreamWriter xsw,
 String id,
 Class<?> exporterType,
 boolean optional)
                            throws 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:

XMLStreamException

setExporterType

public void setExporterType(XMLStreamWriter xsw,
 Exporter exporter)
                     throws 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:

XMLStreamException

setExporterType

public void setExporterType(XMLStreamWriter xsw,
 Class<? extends Exporter> type)
                     throws 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:

XMLStreamException

setEnclosedAttributes

public void setEnclosedAttributes(XMLStreamWriter xsw,
 Exporter exporter)
                           throws 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:

XMLStreamException

setNameAttribute

public void setNameAttribute(XMLStreamWriter xsw,
 String name)
                      throws 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:

XMLStreamException

addNamespaces

public void addNamespaces(XMLStreamWriter xsw)
                   throws XMLStreamException

Throws:

XMLStreamException

writeExImportNamespace

public void writeExImportNamespace(XMLStreamWriter xsw)
                            throws XMLStreamException

Throws:

XMLStreamException

getNamespaceMap

public Map getNamespaceMap()

xqueryNamespaces

public String xqueryNamespaces()

xpathContext

public XPathContext xpathContext()

getAllowedReferenceTypesFor

public Set<Class<?>> getAllowedReferenceTypesFor(Object node,
 List<Exporter> exporters)