net.datenwerke.eximport

Interface ExportDataAnalyzerService

All Known Implementing Classes:

ExportDataAnalyzerServiceImpl

public interface ExportDataAnalyzerService

Helper Service that allows to analize an export file.

See Also:

ExportService

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttribute(Element el, java.lang.String attribute) Returns the Elements value of the given attribute
java.util.List<Element>	getCollectionValueElementsFor(Element el) Returns the collection value elements for a given element as a NodeList
java.util.List<ItemProperty>	getCollectionValuesFor(Element el) Returns a List of ItemPropertys for the given Elements collection value element
EnclosedItemProperty	getEnclosedPropertyFor(Element el) Returns the EnclosedItemProperty for the given Element
EnclosedItemProperty	getEnclosedPropertyFor(ExportDataProvider dataProvider, java.lang.String id) Returns the EnclosedItemProperty for the exported element identified by the given ID.
java.util.Date	getExportDate(ExportDataProvider dataProvider) Returns the export Date of a given Document
java.lang.String	getExportDescription(ExportDataProvider dataProvider) Returns the export description of a given Document
ExportedItem	getExportedItemById(ExportDataProvider dataProvider, java.lang.String id) Gets the ExportedItem identified by the given ID.
Elements	getExportedItemElementsFor(ExportDataProvider dataProvider, java.lang.Class<? extends Exporter> exporter) Returns the exported item elements for a Document with a given Exporter as a NodeList
ExportedItem	getExportedItemFor(Element el, ExportDataProvider dataProvider) Gets the ExportedItem for the given Element
java.util.List<ExportedItem>	getExportedItemsFor(ExportDataProvider dataProvider, java.lang.Class<? extends Exporter> exporter) Get a List of ExportedItems from the given Document and Exporter
ExportedItem	getExportedItemWithEnclosed(ExportDataProvider dataProvider, java.lang.String id) Gets the ExportedItem identified by the given ID including enclosed elements.
java.lang.Class<?>	getExporterClass(Element el) Returns the Class of the exporter of the given Element
java.util.Collection<java.lang.Class<?>>	getExporterClasses(ExportDataProvider dataProvider) Returns a Collection of exporter Classes of a given Document
Elements	getExporterElements(ExportDataProvider dataProvider) Returns a NodeList of exporter elements of a given Document
java.lang.Class<?>	getExporterForEnclosed(ExportDataProvider dataProvider, java.lang.String id) Gets the Class of the exporter type used for the enclosed elements of the Element identified by the given ID.
java.lang.String	getExportName(ExportDataProvider dataProvider) Returns the export name of a given Document
java.lang.String	getItemId(Element el) Returns the ID attribute of the given Element
java.util.Collection<ItemProperty>	getItemPropertiesFor(Element el) Returns a Collection of ItemPropertys for the given Element
ItemProperty	getItemPropertyFor(Element el) Returns the ItemProperty for the given Element
java.util.List<Element>	getItemsPropertyElements(Element el) Returns the Elements property elements as a NodeList
java.lang.String	getItemType(Element el) Returns the type attribute of the given Element
java.lang.Class<?>	getItemTypeAsClass(Element el) Returns the type attribute of the given Element as a Class
ExportedItem	getRoot(ExportDataProvider dataProvider, java.lang.Class<? extends Exporter> exporter)
boolean	hasAttribute(Element el, java.lang.String attribute) Checks wether the given Element has the given attribute or not
boolean	isExportedItemElement(Element el) Checks wether a given Element is an exported item element or not
void	validateExportedItemElement(Element el) Validates the given exported item Element

Method Detail

getExportName

java.lang.String getExportName(ExportDataProvider dataProvider)

Returns the export name of a given Document

Returns:

The export name of the Document

getExportDescription

java.lang.String getExportDescription(ExportDataProvider dataProvider)

Returns the export description of a given Document

Returns:

The export description of the Document

getExportDate

java.util.Date getExportDate(ExportDataProvider dataProvider)

Returns the export Date of a given Document

Returns:

The export Date

getExporterElements

Elements getExporterElements(ExportDataProvider dataProvider)

Returns a NodeList of exporter elements of a given Document

Returns:

A NodeList of exporter elements

getExporterClasses

java.util.Collection<java.lang.Class<?>> getExporterClasses(ExportDataProvider dataProvider)
                                                     throws java.lang.ClassNotFoundException

Returns a Collection of exporter Classes of a given Document

Returns:

A Collection of exporter Classes

Throws:

java.lang.ClassNotFoundException

getExporterClass

java.lang.Class<?> getExporterClass(Element el)
                             throws java.lang.ClassNotFoundException

Returns the Class of the exporter of the given Element

Parameters:

el - The Element

Returns:

The Class of the exporter

Throws:

java.lang.ClassNotFoundException

getExportedItemsFor

java.util.List<ExportedItem> getExportedItemsFor(ExportDataProvider dataProvider,
                                                 java.lang.Class<? extends Exporter> exporter)
                                          throws java.lang.ClassNotFoundException

Get a List of ExportedItems from the given Document and Exporter

Parameters:

exporter - The Exporter to use

Returns:

A List of ExportedItems

Throws:

java.lang.ClassNotFoundException

getExportedItemFor

ExportedItem getExportedItemFor(Element el,
                                ExportDataProvider dataProvider)
                         throws java.lang.ClassNotFoundException

Gets the ExportedItem for the given Element

Parameters:

el - The Element

dataProvider -

Returns:

The ExportedItem

Throws:

java.lang.ClassNotFoundException

getItemPropertiesFor

java.util.Collection<ItemProperty> getItemPropertiesFor(Element el)
                                                 throws java.lang.ClassNotFoundException

Returns a Collection of ItemPropertys for the given Element

Parameters:

el - The Element

Returns:

A Collection of ItemPropertys

Throws:

java.lang.ClassNotFoundException

getItemPropertyFor

ItemProperty getItemPropertyFor(Element el)
                         throws java.lang.ClassNotFoundException

Returns the ItemProperty for the given Element

Parameters:

el - The Element

Returns:

The ItemProperty

Throws:

java.lang.ClassNotFoundException

getEnclosedPropertyFor

EnclosedItemProperty getEnclosedPropertyFor(Element el)
                                     throws java.lang.ClassNotFoundException

Returns the EnclosedItemProperty for the given Element

Parameters:

el - The Element

Returns:

The EnclosedItemProperty

Throws:

java.lang.ClassNotFoundException

getCollectionValuesFor

java.util.List<ItemProperty> getCollectionValuesFor(Element el)
                                             throws java.lang.ClassNotFoundException

Returns a List of ItemPropertys for the given Elements collection value element

Parameters:

el - The Element

Returns:

A List of ItemPropertys

Throws:

java.lang.ClassNotFoundException

getCollectionValueElementsFor

java.util.List<Element> getCollectionValueElementsFor(Element el)

Returns the collection value elements for a given element as a NodeList

Parameters:

el - The Element

Returns:

The collection value elements as a NodeList

getExportedItemElementsFor

Elements getExportedItemElementsFor(ExportDataProvider dataProvider,
                                    java.lang.Class<? extends Exporter> exporter)

Returns the exported item elements for a Document with a given Exporter as a NodeList

isExportedItemElement

boolean isExportedItemElement(Element el)

Checks wether a given Element is an exported item element or not

Parameters:

el - The Element

Returns:

True if the Element is an exporter item element; False otherwise

validateExportedItemElement

void validateExportedItemElement(Element el)

Validates the given exported item Element

Parameters:

el - The exported item Element

getItemId

java.lang.String getItemId(Element el)

Returns the ID attribute of the given Element

Parameters:

el - The Element

Returns:

The ID attribute

getItemType

java.lang.String getItemType(Element el)

Returns the type attribute of the given Element

Parameters:

el - The Element

Returns:

The type attribute

getItemTypeAsClass

java.lang.Class<?> getItemTypeAsClass(Element el)
                               throws java.lang.ClassNotFoundException

Returns the type attribute of the given Element as a Class

Parameters:

el - The Element

Returns:

The type attribute as a Class

Throws:

java.lang.ClassNotFoundException

getItemsPropertyElements

java.util.List<Element> getItemsPropertyElements(Element el)

Returns the Elements property elements as a NodeList

Parameters:

el - The Element

Returns:

The property elements as a NodeList

hasAttribute

boolean hasAttribute(Element el,
                     java.lang.String attribute)

Checks wether the given Element has the given attribute or not

Parameters:

el - The Element

attribute - The attribute

Returns:

True if the Element as the given attribute; False otherwise

getAttribute

java.lang.String getAttribute(Element el,
                              java.lang.String attribute)

Returns the Elements value of the given attribute

Parameters:

el - The Element

attribute - The attribute

Returns:

The value of the given attribute

getExportedItemById

ExportedItem getExportedItemById(ExportDataProvider dataProvider,
                                 java.lang.String id)
                          throws java.lang.ClassNotFoundException

Gets the ExportedItem identified by the given ID.

Parameters:

id - The ID of the ExportedItem

Returns:

The ExportedItem or null

Throws:

java.lang.ClassNotFoundException

getExportedItemWithEnclosed

ExportedItem getExportedItemWithEnclosed(ExportDataProvider dataProvider,
                                         java.lang.String id)
                                  throws java.lang.ClassNotFoundException

Gets the ExportedItem identified by the given ID including enclosed elements.

Parameters:

id - The ID of the ExportedItem

Returns:

The ExportedItem including enclosed elements or null

Throws:

java.lang.ClassNotFoundException

getExporterForEnclosed

java.lang.Class<?> getExporterForEnclosed(ExportDataProvider dataProvider,
                                          java.lang.String id)
                                   throws java.lang.ClassNotFoundException

Gets the Class of the exporter type used for the enclosed elements of the Element identified by the given ID.

Parameters:

id - The ID of the exported element

Returns:

The Class of the used exporter type or null

Throws:

java.lang.ClassNotFoundException

getEnclosedPropertyFor

EnclosedItemProperty getEnclosedPropertyFor(ExportDataProvider dataProvider,
                                            java.lang.String id)
                                     throws java.lang.ClassNotFoundException

Returns the EnclosedItemProperty for the exported element identified by the given ID.

Parameters:

id - The ID of the exported Element

Returns:

The EnclosedItemProperty of the exported element

Throws:

java.lang.ClassNotFoundException

getRoot

ExportedItem getRoot(ExportDataProvider dataProvider,
                     java.lang.Class<? extends Exporter> exporter)
              throws java.lang.ClassNotFoundException

Throws:

java.lang.ClassNotFoundException