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

Method Details

getExportName

String getExportName(ExportDataProvider dataProvider)

Returns the export name of a given

invalid reference

Document

Returns:

The export name of the

invalid reference

Document

getExportDescription

String getExportDescription(ExportDataProvider dataProvider)

Returns the export description of a given

invalid reference

Document

Returns:

The export description of the

invalid reference

Document

getExportDate

Date getExportDate(ExportDataProvider dataProvider)

Returns the export Date of a given

invalid reference

Document

Returns:

The export Date

getExporterElements

Elements getExporterElements(ExportDataProvider dataProvider)

Returns a NodeList of exporter elements of a given

invalid reference

Document

Returns:

A NodeList of exporter elements

getExporterClasses

Collection<Class<? extends Exporter>> getExporterClasses(ExportDataProvider dataProvider)
                                                  throws ClassNotFoundException

Returns a Collection of exporter Classes of a given

invalid reference

Document

Returns:

A Collection of exporter Classes

Throws:

ClassNotFoundException

getExporterClass

Class<? extends Exporter> getExporterClass(Element el)
                                    throws ClassNotFoundException

Returns the Class of the exporter of the given

invalid reference

Element

Parameters:

el - The

invalid reference

Element

Returns:

The Class of the exporter

Throws:

ClassNotFoundException

getExportedItemsFor

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

Get a List of ExportedItems from the given

invalid reference

Document

and Exporter

Parameters:

exporter - The Exporter to use

Returns:

A List of ExportedItems

Throws:

ClassNotFoundException

getExportedItemFor

ExportedItem getExportedItemFor(Element el,
 ExportDataProvider dataProvider)
                         throws ClassNotFoundException

Gets the ExportedItem for the given

invalid reference

Element

Parameters:

el - The

invalid reference

Element

dataProvider -

Returns:

The ExportedItem

Throws:

ClassNotFoundException

getItemPropertiesFor

Collection<ItemProperty> getItemPropertiesFor(Element el)
                                       throws ClassNotFoundException

Returns a Collection of ItemPropertys for the given

invalid reference

Element

Parameters:

el - The

invalid reference

Element

Returns:

A Collection of ItemPropertys

Throws:

ClassNotFoundException

getItemPropertyFor

ItemProperty getItemPropertyFor(Element el)
                         throws ClassNotFoundException

Returns the ItemProperty for the given

invalid reference

Element

Parameters:

el - The

invalid reference

Element

Returns:

The ItemProperty

Throws:

ClassNotFoundException

getEnclosedPropertyFor

EnclosedItemProperty getEnclosedPropertyFor(Element el)
                                     throws ClassNotFoundException

Returns the EnclosedItemProperty for the given

invalid reference

Element

Parameters:

el - The

invalid reference

Element

Returns:

The EnclosedItemProperty

Throws:

ClassNotFoundException

getCollectionValuesFor

List<ItemProperty> getCollectionValuesFor(Element el)
                                   throws ClassNotFoundException

Returns a List of ItemPropertys for the given

invalid reference

Element

s collection value element

Parameters:

el - The

invalid reference

Element

Returns:

A List of ItemPropertys

Throws:

ClassNotFoundException

getCollectionValueElementsFor

List<Element> getCollectionValueElementsFor(Element el)

Returns the collection value elements for a given

invalid reference

element

as a NodeList

Parameters:

el - The

invalid reference

Element

Returns:

The collection value elements as a NodeList

getExportedItemElementsFor

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

Returns the exported item elements for a

invalid reference

Document

with a given Exporter as a NodeList

isExportedItemElement

boolean isExportedItemElement(Element el)

Checks wether a given

invalid reference

Element

is an exported item element or not

Parameters:

el - The

invalid reference

Element

Returns:

True if the

invalid reference

Element

is an exporter item element; False otherwise

validateExportedItemElement

void validateExportedItemElement(Element el)

Validates the given exported item

invalid reference

Element

Parameters:

el - The exported item

invalid reference

Element

getItemId

String getItemId(Element el)

Returns the ID attribute of the given

invalid reference

Element

Parameters:

el - The

invalid reference

Element

Returns:

The ID attribute

getItemType

String getItemType(Element el)

Returns the type attribute of the given

invalid reference

Element

Parameters:

el - The

invalid reference

Element

Returns:

The type attribute

getItemTypeAsClass

Class<?> getItemTypeAsClass(Element el)
                     throws ClassNotFoundException

Returns the type attribute of the given

invalid reference

Element

as a Class

Parameters:

el - The

invalid reference

Element

Returns:

The type attribute as a Class

Throws:

ClassNotFoundException

getItemsPropertyElements

List<Element> getItemsPropertyElements(Element el)

Returns the

invalid reference

Element

s property elements as a NodeList

Parameters:

el - The

invalid reference

Element

Returns:

The property elements as a NodeList

hasAttribute

boolean hasAttribute(Element el,
 String attribute)

Checks wether the given

invalid reference

Element

has the given attribute or not

Parameters:

el - The

invalid reference

Element

attribute - The attribute

Returns:

True if the

invalid reference

Element

as the given attribute; False otherwise

getAttribute

String getAttribute(Element el,
 String attribute)

Returns the

invalid reference

Element

s value of the given attribute

Parameters:

el - The

invalid reference

Element

attribute - The attribute

Returns:

The value of the given attribute

getExportedItemById

ExportedItem getExportedItemById(ExportDataProvider dataProvider,
 String id)
                          throws ClassNotFoundException

Gets the ExportedItem identified by the given ID.

Parameters:

id - The ID of the ExportedItem

Returns:

The ExportedItem or null

Throws:

ClassNotFoundException

getExportedItemWithEnclosed

ExportedItem getExportedItemWithEnclosed(ExportDataProvider dataProvider,
 String id)
                                  throws 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:

ClassNotFoundException

getExporterForEnclosed

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

Gets the Class of the exporter type used for the enclosed elements of the

invalid reference

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:

ClassNotFoundException

getEnclosedPropertyFor

EnclosedItemProperty getEnclosedPropertyFor(ExportDataProvider dataProvider,
 String id)
                                     throws 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:

ClassNotFoundException

getRoot

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

Throws:

ClassNotFoundException