com.luciad.format.xml.util

LuciadLightspeedClass TLcdXMLPeeker

java.lang.Object

com.luciad.format.xml.util.TLcdXMLPeeker

All Implemented Interfaces:

ILcdInputStreamFactoryCapable

public class TLcdXMLPeeker
extends Object
implements ILcdInputStreamFactoryCapable

Allows to quickly determine the type of an XML file without consuming the input stream. This can be used, for example, to choose a XML decoder for a data source or to implement a canDecode method. Example usage:

   String namespaceURI = TLcdXMLPeeker.decodeRootElementName(inputStream).getNamespaceURI();
   if (myNamespaceV1.equals(namespaceURI)) {
     return myDecoderV1.decode(inputStream);
   } else if (myNamespaceV2.equals(namespaceURI)) {
     return myDecoderV2.decode(inputStream);
   } else {
     ...
   }
 

The used ILcdInputStreamFactory must create streams that support marking (most buffered input streams do). If not, an exception is thrown.

Since:

2017.1

Constructor Summary

Constructors

Constructor and Description
TLcdXMLPeeker() Creates a new peeker.
TLcdXMLPeeker(ILcdInputStreamFactory aFactory) Creates a new peeker that uses the given input stream factory.

Method Summary

Modifier and Type	Method and Description
static QName	decodeRootElementName(InputStream aInputStream) Decodes the name of the root element in the given input stream.
QName	decodeRootElementName(String aSource) Decodes the name of the root element in the given source.
ILcdInputStreamFactory	getInputStreamFactory() Returns the input stream factory that is used.
void	setInputStreamFactory(ILcdInputStreamFactory aInputStreamFactory) Sets the input stream factory to be used.

Methods inherited from class java.lang.Object

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

Constructor Detail

TLcdXMLPeeker

public TLcdXMLPeeker()

Creates a new peeker.

TLcdXMLPeeker

public TLcdXMLPeeker(ILcdInputStreamFactory aFactory)

Creates a new peeker that uses the given input stream factory.

Parameters:

aFactory - the factory to use when decoding a source

Method Detail

decodeRootElementName

public QName decodeRootElementName(String aSource)
                            throws IOException

Decodes the name of the root element in the given source.

Parameters:

aSource - the source file to peek into

Returns:

the name of the root element in the source

Throws:

IOException

decodeRootElementName

public static QName decodeRootElementName(InputStream aInputStream)
                                   throws IOException

Decodes the name of the root element in the given input stream.

Parameters:

aInputStream - the stream to peek into. The stream must support marking.

Returns:

the name of the root element in the source

Throws:

IllegalArgumentException - if the input stream does not support marking

IOException

setInputStreamFactory

public void setInputStreamFactory(ILcdInputStreamFactory aInputStreamFactory)

Sets the input stream factory to be used. The factory must create streams that support marking (most buffered input streams do).

Specified by:

setInputStreamFactory in interface ILcdInputStreamFactoryCapable

Parameters:

aInputStreamFactory - the input stream factory to be used.

getInputStreamFactory

public ILcdInputStreamFactory getInputStreamFactory()

Description copied from interface: ILcdInputStreamFactoryCapable

Returns the input stream factory that is used.

Specified by:

getInputStreamFactory in interface ILcdInputStreamFactoryCapable

Returns:

the input stream factory that is used.