com.highqsoft.moma.rules.xatf

Class XATFReader

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.moma.rules.xatf.XATFReader

All Implemented Interfaces:

ExecutableIF, ImplementationIF

Direct Known Subclasses:

XATFReader

public class XATFReader
extends AbstractImplementation
implements ExecutableIF

\page AtfxRules \section XATFReader \addindex XATFReader This rule reads an XATF file and stores the content in memory. Subsequent rules are used to read the different elements, optionally modify them and write them into the target ODS database. When a XATF-file with external components is opened by ODS, external components are completely resolved and presented as normal values in the local columns. With the XATFReader the components are kept separately. This way they can be copied to the external storage of a mixed mode ODS server. \subsection XATFReaderProperties Properties \addindex XATFReader Properties The XATFReader is initialized with the following properties: \li \b ReferenceName (required, no default)
The name of reference where the object must be stored in the context. This reference is used by subsequent rules, for example the RebuildElement rule. \li \b XATFFilenameRef (optional, no default)
The name of reference where the ATF/XML file name to read is stored in the context. \li \b XATFFilename (optional, no default)
The name of the ATF/XML file to read. \li \b AcceptAvlExtref (optional, default false)
If this flag is true, the XATFReader accepts AVL files that have an incorrect syntax for external references. The tags may be omitted and also description or mimetype tags can be missing. Either XATFFilenameRef or XATFFilename must be specified. \subsection XATFReaderExample Example \addindex XATFReader Example The example below is called from the sequence in a modelmapper control file. It opens and reads the XATF File stored in the property XATFFile. \code \endcode \subsection XATFReaderMomaMethods Methods used within the Modelmapper \li void execute()
Verify if all component files referenced in the ATFX file exist. \subsection XATFReaderOtherMethods Methods that can be called from other rules \addindex XATFReader Other Public Methods \li String getComponentFilename(String componentName)
Get the real filename of the component. \li String[] getComponentNames()
Get all component names. \li NameValueUnit[][] getComponentValues (String ElementName)
Get the component descriptions of all local columns. ElementName is the AE-Name of the Local Columns. \li HashMap getDocumentaiton()
Get the referenced documentation from the ATF-XML file. The tag 'documentation' is returned. \li String[] getExternalComponents()
Get the referenced external components from the ATF-XML file. The tag 'externalcomponents' is returned. \li String[] getFilenames()
Get the referenced files from the ATF-XML file. The tag 'files' is returned. \li NameValueUnit[][] getLcValues(String elementName)
Get the values from all Local Columns. \li NameValueUnit[][] getValues(String elementName)
Get all instances and attributes of the Application Element elementName. \li updateFilename(String oldFilename, String newFilename)
Change the filename of a component.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.w3c.dom.Document	dom The Document object map of the ATF/XML file.
protected java.lang.String[]	lcValuesNames The list with the names of the values attributes of the localcolumns.

Fields inherited from class com.highqsoft.xsd.AbstractImplementation

arguments, ctx, descriptor, NEW_LINE

Constructor Summary

Constructors

Constructor and Description
XATFReader() Constructur of the XATFReader.
XATFReader(java.lang.String filename) Constructur of the XATFReader.

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() Verify the existance of the external components defined in XATF-file.
java.lang.String	getComponentFilename(java.lang.String componentName) Get the filename of the component.
java.lang.String[]	getComponentNames() Get the list of the component names from the XML-Document.
NameValueUnit[][]	getComponentValues(java.lang.String elementName) Get the component description of the values of all localcolumn instances.
java.util.HashMap<java.lang.String,java.lang.String>	getDocumentation() Get the documentation from the ATF-XML file.
org.w3c.dom.Node	getElement(java.lang.String elementName) Get the element description from the ATF-XML file.
java.lang.String[]	getExternalComponents() Get the external components from the ATF-XML file.
java.lang.String	getFilename() Get the filename.
java.lang.String[]	getFilenames() Get the list of the filenames from the XML-Document.
org.w3c.dom.Node	getInstanceData() Get the instance data from the ATF-XML file.
NameValueUnit[][]	getLcValues(java.lang.String elementName) Get the values of all localcolumn instances.
NameValueUnit[][]	getLcValues(java.lang.String elementName, org.w3c.dom.Node[] selElems) Get the values of all localcolumn instances.
NameValueUnit[][]	getValues(java.lang.String elementName) Get the attribute values of all instances of the given application element.
void	init() Initialize the ATF/XML Reader.
static void	main(java.lang.String[] args) Main program.
void	setFilename(java.lang.String filename) Set the filename.
void	terminate() The terminate method, nothing to do.
void	updateFilename(java.lang.String oldFilename, java.lang.String newFilename) Update the filename of the components in the map.

Methods inherited from class com.highqsoft.xsd.AbstractImplementation

addAttributesToNameValueUnitArray, addAttributeToNameValueUnitArray, addStringValueToNameValueUnitArray, checkDirectoy, checkDirectoy, checkDirectoy, checkFile, checkFile, checkFile, checkIntValue, checkStringValue, compressNvuArray, createMessageFromPropertyFile, createMessageFromPropertyFile, createMessageFromPropertyFile, createTsUnionFromObject, deleteRowWithAttributes, getArguments, getContext, getDescriptor, getListFromProperty, getMandatoryProperty, getMandatoryProperty, getMandatoryPropertyAsInt, getMandatoryPropertyAsList, getMandatoryPropertyWithRuleException, getNvuArrayFromMap, getNvuArrayFromMap, getNvuObjectWithName, getNvuObjectWithName, getNvuObjectWithName, getOdsCacheFromProperty, getOptioanlPropertyAsInt, getOptionalProperty, getOptionalProperty, getOptionalProperty, getOptionalProperty, getOptionalPropertyAsBoolean, getOptionalPropertyAsBoolean, getOptionalPropertyAsBoolean, getOptionalPropertyAsList, makeUpperCaseKeyword, removeAttributeFromNameValueUnitArray, removeAttributeFromNameValueUnitArray, setArguments, setContext, setDescriptor

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.highqsoft.xsd.ImplementationIF

getContext, getDescriptor, setArguments, setContext, setDescriptor

Field Detail

dom

protected org.w3c.dom.Document dom

The Document object map of the ATF/XML file.

lcValuesNames

protected java.lang.String[] lcValuesNames

The list with the names of the values attributes of the localcolumns.

Constructor Detail

XATFReader

public XATFReader(java.lang.String filename)

Constructur of the XATFReader.

Parameters:

filename - - the filename of the file to read.

XATFReader

public XATFReader()

Constructur of the XATFReader.

Method Detail

terminate

public void terminate()
               throws TerminationException

The terminate method, nothing to do.

Specified by:

terminate in interface ExecutableIF

Throws:

TerminationException - if termination fails.

See Also:

ExecutableIF.terminate()

getFilename

public java.lang.String getFilename()

Get the filename.

Returns:

the filename of the file to read.

setFilename

public void setFilename(java.lang.String filename)

Set the filename.

Parameters:

filename - - the filename of the file to read.

init

public void init()
          throws InitializationFailedException

Initialize the ATF/XML Reader. Parse the ATF/XML file.

Specified by:

init in interface ImplementationIF

Specified by:

init in class AbstractImplementation

Throws:

InitializationFailedException - - When one of the requiered arguments not exist.

See Also:

com.highqsoft.xsd.ImplentationIF#init()

execute

public void execute()
             throws ExecutableException

Verify the existance of the external components defined in XATF-file.
Extract the filenames of all components. Check these filenames against the filesystem.

Specified by:

execute in interface ExecutableIF

Throws:

ExecutableException - if external components are requred but not found.

See Also:

ExecutableIF.execute()

getInstanceData

public org.w3c.dom.Node getInstanceData()
                                 throws XATFTagNotFound

Get the instance data from the ATF-XML file. The instance data is identified with the node name 'instance_data'.

Returns:

the list with the nodes with instance data. The list is normaly one node.

Throws:

XATFTagNotFound

getElement

public org.w3c.dom.Node getElement(java.lang.String elementName)
                            throws XATFTagNotFound

Get the element description from the ATF-XML file. The tag 'application_element', with the child node 'name' must match with the element name.

Parameters:

elementName - - the name of the application element to find.

Returns:

the node with element.

Throws:

XATFTagNotFound

getDocumentation

public java.util.HashMap<java.lang.String,java.lang.String> getDocumentation()
                                                                      throws XATFTagNotFound

Get the documentation from the ATF-XML file. The tag 'documentation' is returned

Returns:

Hashtable with all name / value pairs found in the documentation node

Throws:

XATFTagNotFound

getExternalComponents

public java.lang.String[] getExternalComponents()
                                         throws XATFTagNotFound

Get the external components from the ATF-XML file. The tag 'documentation' is returned

Returns:

Hashtable with all name / value pairs found in the documentation node

Throws:

XATFTagNotFound

getComponentNames

public java.lang.String[] getComponentNames()
                                     throws XATFTagNotFound

Get the list of the component names from the XML-Document. The components are defined ijn the tag 'files'. The components are the only child nodes of the files. The name of the component is given at the tag 'identifier' in the child node of the component.

Returns:

the list with the component names.

Throws:

XATFTagNotFound

getFilenames

public java.lang.String[] getFilenames()
                                throws XATFTagNotFound

Get the list of the filenames from the XML-Document. The components are defined in the tag 'files'. The components are the only child nodes of the files. The name of the component is given at the tag 'filename' in the child node of the component.

Returns:

the list with the filenames.

Throws:

XATFTagNotFound

updateFilename

public void updateFilename(java.lang.String oldFilename,
                  java.lang.String newFilename)

Update the filename of the components in the map.

Parameters:

oldFilename - - the old filename.

newFilename - - the new filename.

getComponentFilename

public java.lang.String getComponentFilename(java.lang.String componentName)

Get the filename of the component.

Parameters:

componentName - - the component name

Returns:

the filename.

getValues

public NameValueUnit[][] getValues(java.lang.String elementName)

Get the attribute values of all instances of the given application element.

Parameters:

elementName - - the name of the application element.

Returns:

the attribute values of the instances.

Throws:

ExecutableException

getLcValues

public NameValueUnit[][] getLcValues(java.lang.String elementName)
                              throws RuleException

Get the values of all localcolumn instances.

Parameters:

elementName - - the name of the localcolumn application element.

Returns:

the values of the instances. The first column is the Id.

Throws:

RuleException

getLcValues

public NameValueUnit[][] getLcValues(java.lang.String elementName,
                            org.w3c.dom.Node[] selElems)
                              throws RuleException

Get the values of all localcolumn instances.

Parameters:

elementName - - the name of the localcolumn application element.

Returns:

the values of the instances. The first column is the Id.

Throws:

RuleException

getComponentValues

public NameValueUnit[][] getComponentValues(java.lang.String elementName)
                                     throws RuleException

Get the component description of the values of all localcolumn instances.

Parameters:

elementName - - the name of the localcolumn application element.

Returns:

the values of the instances. The first column is the Id.

Throws:

RuleException

main

public static void main(java.lang.String[] args)

Main program.

Parameters:

args - - First argument is the atf-xml file.