com.luciad.format.xml

LuciadLightspeedClass TLcdXMLDecoder

java.lang.Object

com.luciad.format.xml.TLcdXMLDecoder

All Implemented Interfaces:

ILcdInputStreamFactoryCapable

Deprecated.

Use of the com.format.xml API has been deprecated. Instead, use the com.format.xml.bind API.

public class TLcdXMLDecoder
extends Object
implements ILcdInputStreamFactoryCapable

A generic XML decoder. All actual handling is done by ILcdXMLElementReader's, provided by an ILcdXMLElementReaderProvider. The decoder will read the XML document, and, for each start of an element (opening XML tag), content or end of an element (closing XML tag), retrieve an element reader via the element reader provider or another reader, and call the reader's corresponding method, with the current element name stack as a parameter (and, optionally, other relevant parameters). A matching reader is retrieved as follows:

• When the start tag of the root element of the document is read, a reader is retrieved immediately via the element reader provider
• Otherwise, a child reader is retrieved via the current element reader (i.e., the reader that processes the parent element)

See Also:

ILcdXMLElementReader, ILcdXMLElementReaderProvider

Constructor Summary

Constructors

Constructor and Description
TLcdXMLDecoder() Deprecated. Creates a new XML decoder instance.

Method Summary

Modifier and Type	Method and Description
Object	decodeXML(String aSource) Deprecated. Processes the given XML source document, and returns the object that is created by the root element's reader - and can thus be anything.
ILcdXMLElementReaderProvider	getElementReaderProvider() Deprecated. Returns the currently used ILcdXMLElementreaderProvider.
ILcdInputStreamFactory	getInputStreamFactory() Deprecated. Returns the input stream factory that is currently used for creating input streams given source names.
ILcdXMLPrefixMap	getPrefixMap() Deprecated. Returns the prefix map that is used by this decoder.
ILcdXMLSchemaLocationsMap	getSchemaLocationsMap() Deprecated. Returns the ILcdXMLSchemaLocationsMap that contains all schema locations read during the decoding of XML documents.
void	setElementReaderProvider(ILcdXMLElementReaderProvider aReaderSupport) Deprecated. Sets the ILcdXMLElementReaderProvider to be used.
void	setInputStreamFactory(ILcdInputStreamFactory aInputStreamFactory) Deprecated. Sets the input stream factory that will be used for creating input streams given source names.
void	setPrefixMap(ILcdXMLPrefixMap aPrefixMap) Deprecated. Sets the prefix map to be used by this decoder.
void	setSchemaLocationsMap(ILcdXMLSchemaLocationsMap aSchemaLocationsMap) Deprecated. Sets the ILcdXMLSchemaLocationsMap in which all schema locations that are declared in the read XML documents should be stored.

Methods inherited from class java.lang.Object

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

Constructor Detail

TLcdXMLDecoder

public TLcdXMLDecoder()

Deprecated.

Creates a new XML decoder instance.

Method Detail

setInputStreamFactory

public void setInputStreamFactory(ILcdInputStreamFactory aInputStreamFactory)

Deprecated.

Sets the input stream factory that will be used for creating input streams given source names.

Specified by:

setInputStreamFactory in interface ILcdInputStreamFactoryCapable

Parameters:

aInputStreamFactory - the input stream factory to be used.

getInputStreamFactory

public ILcdInputStreamFactory getInputStreamFactory()

Deprecated.

Returns the input stream factory that is currently used for creating input streams given source names.

Specified by:

getInputStreamFactory in interface ILcdInputStreamFactoryCapable

Returns:

the input stream factory that is currently used.

setElementReaderProvider

public void setElementReaderProvider(ILcdXMLElementReaderProvider aReaderSupport)

Deprecated.

Sets the ILcdXMLElementReaderProvider to be used.

Parameters:

aReaderSupport - the ILcdXMLElementreaderProvider to be used.

getElementReaderProvider

public ILcdXMLElementReaderProvider getElementReaderProvider()

Deprecated.

Returns the currently used ILcdXMLElementreaderProvider.

Returns:

the currently used ILcdXMLElementreaderProvider.

setPrefixMap

public void setPrefixMap(ILcdXMLPrefixMap aPrefixMap)

Deprecated.

Sets the prefix map to be used by this decoder.

Parameters:

aPrefixMap - the prefix map to be used by this decoder.

See Also:

getPrefixMap()

getPrefixMap

public ILcdXMLPrefixMap getPrefixMap()

Deprecated.

Returns the prefix map that is used by this decoder. Each time the decoder reads an XML prefix declaration (xmlns:prefix="namespace"), the prefix, together with its corresponding namespace, will be added to the prefix map. This way, the prefix mapping of the original XML document can be shared with other applications (e.g., an XML encoder).

Returns:

the prefix map that is used by this decoder.

getSchemaLocationsMap

public ILcdXMLSchemaLocationsMap getSchemaLocationsMap()

Deprecated.

Returns the ILcdXMLSchemaLocationsMap that contains all schema locations read during the decoding of XML documents. Each schema location declaration (xsi:schemaLocations="..."), read during the decoding, will be added to the schema locations map. This way, the schema locations of the original XML document can be shared with other applications (e.g., an XML encoder).

Returns:

the ILcdXMLSchemaLocationsMap that contains all schema locations in the decoded XML documents.

See Also:

getSchemaLocationsMap()

setSchemaLocationsMap

public void setSchemaLocationsMap(ILcdXMLSchemaLocationsMap aSchemaLocationsMap)

Deprecated.

Sets the ILcdXMLSchemaLocationsMap in which all schema locations that are declared in the read XML documents should be stored.

Parameters:

aSchemaLocationsMap - the ILcdXMLSchemaLocationsMap in which all schema locations declared in XML documents should be stored.

decodeXML

public Object decodeXML(String aSource)
                 throws IOException

Deprecated.

Processes the given XML source document, and returns the object that is created by the root element's reader - and can thus be anything.

Parameters:

aSource - the full path to the file to be decoded, including the file name.

Returns:

an object containing (part of) the decoded XML data.

Throws:

IOException - thrown if an error occurs during the read process.

IllegalArgumentException - thrown if the supplied argument is null.