com.luciad.reference

LuciadLightspeedClass TLcdModelReferenceEncoder

java.lang.Object

com.luciad.reference.TLcdModelReferenceEncoder

All Implemented Interfaces:

ILcdOutputStreamFactoryCapable, ILcdModelReferenceEncoder

@LcdService(service=ILcdModelReferenceEncoder.class,
            priority=50000)
public class TLcdModelReferenceEncoder
extends Object
implements ILcdModelReferenceEncoder, ILcdOutputStreamFactoryCapable

This ILcdModelReferenceEncoder encodes model references in .ref files corresponding to the given destination files. A .ref file contains properties that define a model reference.

See Also:

TLcdModelReferenceDecoder, TLcdCompositeModelReferenceEncoder

Constructor Summary

Constructors

Constructor and Description
TLcdModelReferenceEncoder()

Method Summary

Modifier and Type	Method and Description
ILcdOutputStreamFactory	getOutputStreamFactory() Sets the input stream factory that is used for writing .ref files.
void	save(ILcdModelReference aModelReference, String aDestinationName) Saves the specified model reference to a location, next to the data destination.
void	setOutputStreamFactory(ILcdOutputStreamFactory aOutputStreamFactory) Sets the output stream factory that will be used for writing .ref files.

Methods inherited from class java.lang.Object

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

Constructor Detail

TLcdModelReferenceEncoder

public TLcdModelReferenceEncoder()

Method Detail

setOutputStreamFactory

public void setOutputStreamFactory(ILcdOutputStreamFactory aOutputStreamFactory)

Sets the output stream factory that will be used for writing .ref files.

Specified by:

setOutputStreamFactory in interface ILcdOutputStreamFactoryCapable

Parameters:

aOutputStreamFactory - the factory responsible to create output streams to which the model references will be encoded.

getOutputStreamFactory

public ILcdOutputStreamFactory getOutputStreamFactory()

Sets the input stream factory that is used for writing .ref files.

Specified by:

getOutputStreamFactory in interface ILcdOutputStreamFactoryCapable

Returns:

the factory responsible to create output streams to which the model references will be encoded.

save

public void save(ILcdModelReference aModelReference,
                 String aDestinationName)
          throws IOException

Description copied from interface: ILcdModelReferenceEncoder

Saves the specified model reference to a location, next to the data destination.

Specified by:

save in interface ILcdModelReferenceEncoder

Parameters:

aModelReference - the ILcdModelReference to be encoded.

aDestinationName - the destination name of the model to which the specified model reference belongs.

Throws:

IOException - if the ILcdModelReference cannot be encoded.