Package com.luciad.format.nvg.nvg20.xml

Class TLcdNVG20ModelEncoder

java.lang.Object

com.luciad.format.xml.bind.schema.ALcdXMLModelEncoder

com.luciad.format.nvg.nvg20.xml.TLcdNVG20ModelEncoder

All Implemented Interfaces:

ILcdOutputStreamFactoryCapable, ILcdModelEncoder, Serializable

@LcdService(service=ILcdModelEncoder.class,
            priority=20000)
public class TLcdNVG20ModelEncoder
extends ALcdXMLModelEncoder

Model encoder for creating an NVG 2.0 document from a given TLcdNVG20Model or TLcdNVG20FilteredModel. This encoder only supports NVG 2.0 models.

Output files

File	Description
*.xml, *.nvg	NVG XML file

Supported file transfer protocols

• This model encoder supports all transfer protocols that are supported by the outputStreamFactory of this encoder.

Supported models

• This model encoder can save and export NVG 2.0 models as described by the TLcdNVGModelDecoder. These models are instances of TLcdNVG20Model or TLcdNVG20FilteredModel.

Sample code

 ILcdModelEncoder encoder = new TLcdNVG20ModelEncoder();
 encoder.export(nvgModel, "file.nvg");
 

Thread safety

• The encoding of models is thread-safe, as long as no properties are changed during the encoding.

Supported versions and specifications

• NATO Vector Graphics Data Format 2.0

Since:

2015.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
TLcdNVG20ModelEncoder()	Creates a new TLcdNVG20ModelEncoder, ready to use.

Method Summary

Modifier and Type	Method	Description
boolean	canExport(ILcdModel aModel, String aDestinationName)	Returns whether this encoder can export the specified model to the specified destination.
boolean	canSave(ILcdModel aModel)	Returns whether this model encoder can save the specified model to the location it originally came from.
void	export(ILcdModel aModel, String aDestinationName)	Exports the specified model to the specified destination.
String	getDisplayName()	Returns a short, displayable name for the format this ILcdModelEncoder encodes to.
EntityResolver2	getEntityResolver()	Returns the org.xml.sax.ext.EntityResolver2 that is used for creating input sources for XSD schemas.
ILcdOutputStreamFactory	getOutputStreamFactory()	Returns the ILcdOutputStreamFactory that is used for creating output streams.
XMLOutputFactory	getXMLOutputFactory()	Returns the javax.xml.stream.XMLOutputFactory that is used by this encoder for creating javax.xml.stream.XMLStreamWriter instances.
void	save(ILcdModel aModel)	Saves the model to the location where it originally came from.
void	setEntityResolver(EntityResolver2 aEntityResolver)	Sets the org.xml.sax.ext.EntityResolver2 to be used for creating input sources for XSD schemas.
void	setOutputStreamFactory(ILcdOutputStreamFactory aOutputStreamFactory)	Sets the ILcdOutputStreamFactory to be used for creating output streams.
void	setXMLOutputFactory(XMLOutputFactory aXMLOutputFactory)	Sets the javax.xml.stream.XMLOutputFactory to be used by this encoder for creating javax.xml.stream.XMLStreamWriter instances.

Methods inherited from class com.luciad.format.xml.bind.schema.ALcdXMLModelEncoder

export

Methods inherited from class java.lang.Object

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

Constructor Details

TLcdNVG20ModelEncoder

public TLcdNVG20ModelEncoder()

Creates a new TLcdNVG20ModelEncoder, ready to use.

Method Details

getDisplayName

public String getDisplayName()

Description copied from interface: ILcdModelEncoder

Returns a short, displayable name for the format this ILcdModelEncoder encodes to.

Returns:

the displayable name of this ILcdModelEncoder.

canSave

public boolean canSave(ILcdModel aModel)

Description copied from interface: ILcdModelEncoder

Returns whether this model encoder can save the specified model to the location it originally came from. Often this will only be a simple test, for example checking the type of the model's model descriptor.

Parameters:

aModel - the model to be verified.

Returns:

true if this encoder can save the model in the location where it originally came from, false otherwise.

See Also:

• ILcdModelEncoder.save(com.luciad.model.ILcdModel)

save

public void save(ILcdModel aModel)
          throws IllegalArgumentException,
IOException

Description copied from interface: ILcdModelEncoder

Saves the model to the location where it originally came from.

Parameters:

aModel - the model to be saved.

Throws:

IllegalArgumentException - if the model cannot be saved by this encoder (!canSave(aModel)).

IOException - if an I/O error occurs during encoding.

canExport

public boolean canExport(ILcdModel aModel,
 String aDestinationName)

Description copied from interface: ILcdModelEncoder

Returns whether this encoder can export the specified model to the specified destination. This method will typically check whether the contents of the specified model are compatible with the format this encoder is written for.

Parameters:

aModel - the model to be verified.

aDestinationName - the location where the model should be exported to.

Returns:

true if this encoder can export the specified model to the specified location, false otherwise.

See Also:

• ILcdModelEncoder.export(com.luciad.model.ILcdModel, java.lang.String)

export

public void export(ILcdModel aModel,
 String aDestinationName)
            throws IllegalArgumentException,
IOException

Description copied from interface: ILcdModelEncoder

Exports the specified model to the specified destination.

Parameters:

aModel - the model to be exported.

aDestinationName - the location where the model should be saved. Typically, this is a name for the output file, but it can also point to a file containing the required properties to create a set of data files.

Throws:

IllegalArgumentException - if the model cannot be saved by this encoder (!canExport(aModel, aDestinationName)).

IOException - if an I/O error occurs during encoding.

getOutputStreamFactory

public ILcdOutputStreamFactory getOutputStreamFactory()

Description copied from class: ALcdXMLModelEncoder

Returns the ILcdOutputStreamFactory that is used for creating output streams.

Specified by:

getOutputStreamFactory in interface ILcdOutputStreamFactoryCapable

Specified by:

getOutputStreamFactory in class ALcdXMLModelEncoder

Returns:

the ILcdOutputStreamFactory that is used for creating output streams.

See Also:

• ALcdXMLModelEncoder.setOutputStreamFactory(com.luciad.io.ILcdOutputStreamFactory)

setOutputStreamFactory

public void setOutputStreamFactory(ILcdOutputStreamFactory aOutputStreamFactory)

Description copied from class: ALcdXMLModelEncoder

Sets the ILcdOutputStreamFactory to be used for creating output streams. This output stream factory is used for output streams for both the data files and the XSD schemas.

Specified by:

setOutputStreamFactory in interface ILcdOutputStreamFactoryCapable

Specified by:

setOutputStreamFactory in class ALcdXMLModelEncoder

Parameters:

aOutputStreamFactory - the output stream factory to be used by this model encoder.

See Also:

• ALcdXMLModelEncoder.setOutputStreamFactory(com.luciad.io.ILcdOutputStreamFactory)

getXMLOutputFactory

public XMLOutputFactory getXMLOutputFactory()

Description copied from class: ALcdXMLModelEncoder

Returns the javax.xml.stream.XMLOutputFactory that is used by this encoder for creating javax.xml.stream.XMLStreamWriter instances.

Specified by:

getXMLOutputFactory in class ALcdXMLModelEncoder

Returns:

the javax.xml.stream.XMLOutputFactory that is used by this encoder for creating javax.xml.stream.XMLStreamWriter instances.

setXMLOutputFactory

public void setXMLOutputFactory(XMLOutputFactory aXMLOutputFactory)

Description copied from class: ALcdXMLModelEncoder

Sets the javax.xml.stream.XMLOutputFactory to be used by this encoder for creating javax.xml.stream.XMLStreamWriter instances.

Specified by:

setXMLOutputFactory in class ALcdXMLModelEncoder

Parameters:

aXMLOutputFactory - the javax.xml.stream.XMLOutputFactory to be used by this encoder for creating javax.xml.stream.XMLStreamWriter instances.

getEntityResolver

public EntityResolver2 getEntityResolver()

Description copied from class: ALcdXMLModelEncoder

Returns the org.xml.sax.ext.EntityResolver2 that is used for creating input sources for XSD schemas.

Specified by:

getEntityResolver in class ALcdXMLModelEncoder

Returns:

the entity resolver to be used for creating input sources for XSD schemas.

setEntityResolver

public void setEntityResolver(EntityResolver2 aEntityResolver)

Description copied from class: ALcdXMLModelEncoder

Sets the org.xml.sax.ext.EntityResolver2 to be used for creating input sources for XSD schemas. This entity resolver is only used for retrieving runtime extension schemas.

Specified by:

setEntityResolver in class ALcdXMLModelEncoder

Parameters:

aEntityResolver - the entity resolver to be used for creating input sources for XSD schemas.