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:
-
Method Summary
Modifier and TypeMethodDescriptiongetAttribute(Element el, String attribute) Returns thes value of the given attributeinvalid reference
ElementList<Element> getCollectionValueElementsFor(Element el) Returns the collection value elements for a givenas ainvalid reference
elementNodeListgetCollectionValuesFor(Element el) getEnclosedPropertyFor(Element el) Returns theEnclosedItemPropertyfor the giveninvalid reference
ElementgetEnclosedPropertyFor(ExportDataProvider dataProvider, String id) Returns theEnclosedItemPropertyfor the exported element identified by the given ID.getExportDate(ExportDataProvider dataProvider) Returns the exportDateof a giveninvalid reference
DocumentgetExportDescription(ExportDataProvider dataProvider) Returns the export description of a giveninvalid reference
DocumentgetExportedItemById(ExportDataProvider dataProvider, String id) Gets theExportedItemidentified by the given ID.ElementsgetExportedItemElementsFor(ExportDataProvider dataProvider, Class<? extends Exporter> exporter) getExportedItemFor(Element el, ExportDataProvider dataProvider) Gets theExportedItemfor the giveninvalid reference
ElementgetExportedItemsFor(ExportDataProvider dataProvider, Class<? extends Exporter> exporter) getExportedItemWithEnclosed(ExportDataProvider dataProvider, String id) Gets theExportedItemidentified by the given ID including enclosed elements.getExporterClass(Element el) Returns theClassof the exporter of the giveninvalid reference
ElementCollection<Class<? extends Exporter>> getExporterClasses(ExportDataProvider dataProvider) ElementsgetExporterElements(ExportDataProvider dataProvider) Returns aNodeListof exporter elements of a giveninvalid reference
DocumentClass<?> getExporterForEnclosed(ExportDataProvider dataProvider, String id) Gets theClassof the exporter type used for the enclosed elements of theidentified by the given ID.invalid reference
ElementgetExportName(ExportDataProvider dataProvider) Returns the export name of a giveninvalid reference
DocumentgetItemId(Element el) Returns the ID attribute of the giveninvalid reference
ElementgetItemPropertiesFor(Element el) getItemPropertyFor(Element el) Returns theItemPropertyfor the giveninvalid reference
ElementList<Element> getItemsPropertyElements(Element el) Returns thes property elements as ainvalid reference
ElementNodeListgetItemType(Element el) Returns the type attribute of the giveninvalid reference
ElementClass<?> getItemTypeAsClass(Element el) Returns the type attribute of the givenas ainvalid reference
ElementClassgetRoot(ExportDataProvider dataProvider, Class<? extends Exporter> exporter) booleanhasAttribute(Element el, String attribute) Checks wether the givenhas the given attribute or notinvalid reference
ElementbooleanisExportedItemElement(Element el) Checks wether a givenis an exported item element or notinvalid reference
ElementvoidvalidateExportedItemElement(Element el) Validates the given exported iteminvalid reference
Element
-
Method Details
-
getExportName
Returns the export name of a giveninvalid reference
Document- Returns:
- The export name of the
invalid reference
Document
-
getExportDescription
Returns the export description of a giveninvalid reference
Document- Returns:
- The export description of the
invalid reference
Document
-
getExportDate
Returns the exportDateof a giveninvalid reference
Document- Returns:
- The export
Date
-
getExporterElements
Returns aNodeListof exporter elements of a giveninvalid reference
Document- Returns:
- A
NodeListof exporter elements
-
getExporterClasses
Collection<Class<? extends Exporter>> getExporterClasses(ExportDataProvider dataProvider) throws ClassNotFoundException - Returns:
- A
Collectionof exporterClasses - Throws:
ClassNotFoundException
-
getExporterClass
Returns theClassof the exporter of the giveninvalid reference
Element- Parameters:
el- Theinvalid reference
Element- Returns:
- The
Classof the exporter - Throws:
ClassNotFoundException
-
getExportedItemsFor
List<ExportedItem> getExportedItemsFor(ExportDataProvider dataProvider, Class<? extends Exporter> exporter) throws ClassNotFoundException - Parameters:
exporter- TheExporterto use- Returns:
- A
Listof ExportedItems - Throws:
ClassNotFoundException
-
getExportedItemFor
ExportedItem getExportedItemFor(Element el, ExportDataProvider dataProvider) throws ClassNotFoundException Gets theExportedItemfor the giveninvalid reference
Element- Parameters:
el- Theinvalid reference
ElementdataProvider-- Returns:
- The
ExportedItem - Throws:
ClassNotFoundException
-
getItemPropertiesFor
- Parameters:
el- Theinvalid reference
Element- Returns:
- A
CollectionofItemPropertys - Throws:
ClassNotFoundException
-
getItemPropertyFor
Returns theItemPropertyfor the giveninvalid reference
Element- Parameters:
el- Theinvalid reference
Element- Returns:
- The
ItemProperty - Throws:
ClassNotFoundException
-
getEnclosedPropertyFor
Returns theEnclosedItemPropertyfor the giveninvalid reference
Element- Parameters:
el- Theinvalid reference
Element- Returns:
- The
EnclosedItemProperty - Throws:
ClassNotFoundException
-
getCollectionValuesFor
- Parameters:
el- Theinvalid reference
Element- Returns:
- A
ListofItemPropertys - Throws:
ClassNotFoundException
-
getCollectionValueElementsFor
Returns the collection value elements for a givenas ainvalid reference
elementNodeList- Parameters:
el- Theinvalid reference
Element- Returns:
- The collection value elements as a
NodeList
-
getExportedItemElementsFor
Elements getExportedItemElementsFor(ExportDataProvider dataProvider, Class<? extends Exporter> exporter) -
isExportedItemElement
boolean isExportedItemElement(Element el) Checks wether a givenis an exported item element or notinvalid reference
Element- Parameters:
el- Theinvalid reference
Element- Returns:
- True if the
is an exporter item element; False otherwise
invalid reference
Element
-
validateExportedItemElement
void validateExportedItemElement(Element el) Validates the given exported iteminvalid reference
Element- Parameters:
el- The exported iteminvalid reference
Element
-
getItemId
Returns the ID attribute of the giveninvalid reference
Element- Parameters:
el- Theinvalid reference
Element- Returns:
- The ID attribute
-
getItemType
Returns the type attribute of the giveninvalid reference
Element- Parameters:
el- Theinvalid reference
Element- Returns:
- The type attribute
-
getItemTypeAsClass
Returns the type attribute of the givenas ainvalid reference
ElementClass- Parameters:
el- Theinvalid reference
Element- Returns:
- The type attribute as a
Class - Throws:
ClassNotFoundException
-
getItemsPropertyElements
Returns thes property elements as ainvalid reference
ElementNodeList- Parameters:
el- Theinvalid reference
Element- Returns:
- The property elements as a
NodeList
-
hasAttribute
Checks wether the givenhas the given attribute or notinvalid reference
Element- Parameters:
el- Theinvalid reference
Elementattribute- The attribute- Returns:
- True if the
as the given attribute; False otherwise
invalid reference
Element
-
getAttribute
Returns thes value of the given attributeinvalid reference
Element- Parameters:
el- Theinvalid reference
Elementattribute- The attribute- Returns:
- The value of the given attribute
-
getExportedItemById
ExportedItem getExportedItemById(ExportDataProvider dataProvider, String id) throws ClassNotFoundException Gets theExportedItemidentified by the given ID.- Parameters:
id- The ID of theExportedItem- Returns:
- The
ExportedItemor null - Throws:
ClassNotFoundException
-
getExportedItemWithEnclosed
ExportedItem getExportedItemWithEnclosed(ExportDataProvider dataProvider, String id) throws ClassNotFoundException Gets theExportedItemidentified by the given ID including enclosed elements.- Parameters:
id- The ID of theExportedItem- Returns:
- The
ExportedItemincluding enclosed elements or null - Throws:
ClassNotFoundException
-
getExporterForEnclosed
Class<?> getExporterForEnclosed(ExportDataProvider dataProvider, String id) throws ClassNotFoundException Gets theClassof the exporter type used for the enclosed elements of theidentified by the given ID.invalid reference
Element- Parameters:
id- The ID of the exported element- Returns:
- The
Classof the used exporter type or null - Throws:
ClassNotFoundException
-
getEnclosedPropertyFor
EnclosedItemProperty getEnclosedPropertyFor(ExportDataProvider dataProvider, String id) throws ClassNotFoundException Returns theEnclosedItemPropertyfor the exported element identified by the given ID.- Parameters:
id- The ID of the exported Element- Returns:
- The
EnclosedItemPropertyof the exported element - Throws:
ClassNotFoundException
-
getRoot
ExportedItem getRoot(ExportDataProvider dataProvider, Class<? extends Exporter> exporter) throws ClassNotFoundException - Throws:
ClassNotFoundException
-