com.luciad.lucy.map

LuciadLightspeedClass TLcyCompositeGXYLayerEncoder

java.lang.Object

com.luciad.lucy.util.TLcyGenericComposite<TLcyGXYLayerEncoderHolder>

com.luciad.lucy.map.TLcyCompositeGXYLayerEncoder

All Implemented Interfaces:

ILcdGXYLayerEncoder, Iterable<TLcyGXYLayerEncoderHolder>

public class TLcyCompositeGXYLayerEncoder
extends TLcyGenericComposite<TLcyGXYLayerEncoderHolder>
implements ILcdGXYLayerEncoder

Composite implementation (see composite design pattern) of ILcdGXYLayerEncoder. It keeps a list of associated ILcdGXYLayerEncoders. When it is asked to encode a layer, it loops over its associated ILcdGXYLayerEncoders to find a suitable ILcdGXYLayerEncoder. That ILcdGXYLayerEncoder is asked to encode the layer.

When creating a new TLcyCompositeGXYLayerEncoder using the default constructor (see TLcyCompositeGXYLayerEncoder(), the created instance will only work on/with the ILcdGXYLayerEncoders registered on this composite instance (see addGXYLayerEncoder(com.luciad.view.gxy.ILcdGXYLayerEncoder, com.luciad.lucy.model.ALcyFileTypeDescriptor) and removeGXYLayerEncoder(com.luciad.view.gxy.ILcdGXYLayerEncoder).

When creating a new TLcyCompositeGXYLayerEncoder using the constructor specifying an ILcyLucyEnv instance (see TLcyCompositeGXYLayerEncoder(com.luciad.lucy.ILcyLucyEnv), the created instance will work on the Lucy back-end services. It will use all registered ILcdGXYLayerEncoder instances of the Lucy back-end, adding and/or removing an ILcdGXYLayerEncoder will add/remove the ILcdGXYLayerEncoder as service from Lucy, ... .

Decoding an ILcdGXYLayer using the back-end based implementation can be done by creating a new instance of this class:

 //Create a new instance whenever you need it
 TLcyCompositeGXYLayerEncoder encoder = new TLcyCompositeGXYLayerEncoder( aLucyEnv );
 if ( encoder.canEncodeGXYLayer( aGXYLayer, aDestinationName ) ){
   try{
     encoder.encodeGXYLayer( aGXYLayer, aDestinationName )
   } catch ( IOException aIOException ){
     //IOException during encoding
   }
 }
 //There is no need to keep a reference to the composite instance, you can create a new one
 //the next time you would need it
 encoder = null;
 

Note: the ILcdGXYLayerEncoders are not directly registered as service to Lucy, but wrapped with a holder object. This holder object allows to register the ILcdGXYLayerEncoder with some extra information like e.g. an ALcyFileTypeDescriptor. Using a back-end based TLcyCompositeGXYLayerEncoder will only use the registered TLcyGXYLayerEncoderHolder objects, and not for example an ILcdGXYLayerEncoder which was directly (=not wrapped) registered as a service .

See Also:

TLcyGXYLayerEncoderHolder

Field Summary

Fields inherited from class com.luciad.lucy.util.TLcyGenericComposite

PRIORITY_DEFAULT, PRIORITY_FALLBACK

Constructor Summary

Constructors

Constructor and Description
TLcyCompositeGXYLayerEncoder() Default constructor.
TLcyCompositeGXYLayerEncoder(ILcyLucyEnv aLucyEnv) Construct a TLcyCompositeGXYLayerEncoder working on the Lucy back-end.

Method Summary

Modifier and Type	Method and Description
void	addGXYLayerEncoder(ILcdGXYLayerEncoder aGXYLayerEncoder, ALcyFileTypeDescriptor aFileTypeDescriptor) Adds the given ILcdGXYLayerEncoder to the list of associated ILcdGXYLayerEncoders.
boolean	canEncodeGXYLayer(ILcdGXYLayer aGXYLayer, String aDestinationName) Loops over its list of associated ILcdGXYLayerEncoders to find a suitable ILcdGXYLayerEncoder.
void	encodeGXYLayer(ILcdGXYLayer aGXYLayer, String aDestinationName) Loops over its list of associated ILcdGXYLayerEncoders to find a suitable ILcdGXYLayerEncoder.
String	getDisplayName() Returns the display name of this encoder.
ALcyFileTypeDescriptor	getFileTypeDescriptor(int aIndex) Returns the layer encoder file type descriptor at the given index.
ILcdGXYLayerEncoder	getGXYLayerEncoder(int aIndex) Returns the ILcdGXYLayerEncoder at the given index.
int	getGXYLayerEncoderCount() Returns the number of associated ILcdGXYLayerEncoders.
void	removeGXYLayerEncoder(ILcdGXYLayerEncoder aGXYLayerEncoder) Removes the given ILcdGXYLayerEncoder from the list of associated ILcdGXYLayerEncoders.
void	setDisplayName(String aDisplayName) Sets the display name of this encoder.

Methods inherited from class com.luciad.lucy.util.TLcyGenericComposite

add, add, getList, getPriority, iterator, remove

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

TLcyCompositeGXYLayerEncoder

public TLcyCompositeGXYLayerEncoder()

Default constructor. No ILcdGXYLayerEncoders are associated.

The created instance will only work on the ILcdGXYLayerEncoder instances registered to it. If you want to use all registered ILcdGXYLayerEncoder instances of the Lucy back-end, use TLcyCompositeGXYLayerEncoder(com.luciad.lucy.ILcyLucyEnv) instead.

See Also:

TLcyCompositeGXYLayerEncoder(com.luciad.lucy.ILcyLucyEnv)

TLcyCompositeGXYLayerEncoder

public TLcyCompositeGXYLayerEncoder(ILcyLucyEnv aLucyEnv)

Construct a TLcyCompositeGXYLayerEncoder working on the Lucy back-end.

It will use all ILcdGXYLayerEncoder instances registered to the back-end, and adding and/or removing ILcdGXYLayerEncoders to/from this TLcyCompositeGXYLayerEncoder will respectively add/remove it as service from the back-end.

If you want to create a TLcyCompositeGXYLayerEncoder which does not use the back-end, use TLcyCompositeGXYLayerEncoder() instead.

Parameters:

aLucyEnv - The Lucy back-end.

See Also:

TLcyCompositeGXYLayerEncoder(), ILcyLucyEnv.addService(Object, int), ILcyLucyEnv.removeService(Object)

Method Detail

addGXYLayerEncoder

public void addGXYLayerEncoder(ILcdGXYLayerEncoder aGXYLayerEncoder,
                               ALcyFileTypeDescriptor aFileTypeDescriptor)

Adds the given ILcdGXYLayerEncoder to the list of associated ILcdGXYLayerEncoders.

If the constructor specifying an ILcyLucyEnv is used, the ALcyFileTypeDescriptor and its associated ILcdGXYLayerEncoder will be registered on the Lucy back-end (see ILcyLucyEnv.addService(Object, int) by using an TLcyGXYLayerEncoderHolder. When calling ILcyLucyEnv.getServices(Class) afterwards, the holder objects will only be returned when the requested class was TLcyGXYLayerEncoderHolder.class.
Note: if you want to remove the registered ALcyFileTypeDescriptor and its associated ILcdGXYLayerEncoder, use removeGXYLayerEncoder(com.luciad.view.gxy.ILcdGXYLayerEncoder) and not ILcyLucyEnv.removeService(Object).

Parameters:

aGXYLayerEncoder - The ILcdGXYLayerEncoder to add

aFileTypeDescriptor - The file type descriptor describing which files this encoder can handle.

See Also:

removeGXYLayerEncoder(com.luciad.view.gxy.ILcdGXYLayerEncoder)

removeGXYLayerEncoder

public void removeGXYLayerEncoder(ILcdGXYLayerEncoder aGXYLayerEncoder)

Removes the given ILcdGXYLayerEncoder from the list of associated ILcdGXYLayerEncoders. Has no effect if the given ILcdGXYLayerEncoder was never added.

If the constructor specifying an ILcyLucyEnv is used, the TLcyGXYLayerEncoderHolder object containing the ILcdGXYLayerEncoder aGXYLayerEncoder will be removed as service from the Lucy back-end (see ILcyLucyEnv.removeService(Object)).
Note: it is only possible to remove TLcyGXYLayerEncoderHolder instances which were registered using the addGXYLayerEncoder(com.luciad.view.gxy.ILcdGXYLayerEncoder, com.luciad.lucy.model.ALcyFileTypeDescriptor) method.

Parameters:

aGXYLayerEncoder - The ILcdGXYLayerEncoder to remove.

See Also:

addGXYLayerEncoder(com.luciad.view.gxy.ILcdGXYLayerEncoder, com.luciad.lucy.model.ALcyFileTypeDescriptor)

getGXYLayerEncoderCount

public int getGXYLayerEncoderCount()

Returns the number of associated ILcdGXYLayerEncoders.

Returns:

the number of associated ILcdGXYLayerEncoders.

See Also:

getGXYLayerEncoder(int)

getGXYLayerEncoder

public ILcdGXYLayerEncoder getGXYLayerEncoder(int aIndex)

Returns the ILcdGXYLayerEncoder at the given index.

Parameters:

aIndex - The index to retrieve the ILcdGXYLayerEncoder at. 0 <= index < getGXYLayerEncoderCount()

Returns:

the ILcdGXYLayerEncoder at the given index.

See Also:

getGXYLayerEncoderCount()

getFileTypeDescriptor

public ALcyFileTypeDescriptor getFileTypeDescriptor(int aIndex)

Returns the layer encoder file type descriptor at the given index. This descriptor is null if the encoder was added with null as a descriptor.

Parameters:

aIndex - The index to retrieve the layer encoder file type descriptor for.

Returns:

the layer encoder file type descriptor at the given index.

See Also:

getGXYLayerEncoderCount()

getDisplayName

public String getDisplayName()

Description copied from interface: ILcdGXYLayerEncoder

Returns the display name of this encoder.

Specified by:

getDisplayName in interface ILcdGXYLayerEncoder

Returns:

the display name of this encoder.

setDisplayName

public void setDisplayName(String aDisplayName)

Sets the display name of this encoder.

Parameters:

aDisplayName - The new display name.

See Also:

getDisplayName()

canEncodeGXYLayer

public boolean canEncodeGXYLayer(ILcdGXYLayer aGXYLayer,
                                 String aDestinationName)

Loops over its list of associated ILcdGXYLayerEncoders to find a suitable ILcdGXYLayerEncoder. Suitable means that when canExport is invoked, it does not throw an exception and it returns true. If returns true if such a suitable ILcdGXYLayerEncoder could be found, false otherwise.

Specified by:

canEncodeGXYLayer in interface ILcdGXYLayerEncoder

Parameters:

aGXYLayer - The layer to export.

aDestinationName - The destination name to export to.

Returns:

True if such a suitable ILcdGXYLayerEncoder could be found, false otherwise.

See Also:

ILcdGXYLayerEncoder.encodeGXYLayer(com.luciad.view.gxy.ILcdGXYLayer, java.lang.String)

encodeGXYLayer

public void encodeGXYLayer(ILcdGXYLayer aGXYLayer,
                           String aDestinationName)
                    throws IOException

Loops over its list of associated ILcdGXYLayerEncoders to find a suitable ILcdGXYLayerEncoder. Suitable means that canExport returns true. It delegates the export to the first suitable ILcdGXYLayerEncoder that was found.

Specified by:

encodeGXYLayer in interface ILcdGXYLayerEncoder

Parameters:

aGXYLayer - The layer to export.

aDestinationName - The destination name to export to.

Throws:

IOException - In case of io failure.

See Also:

ILcdGXYLayerEncoder.canEncodeGXYLayer(com.luciad.view.gxy.ILcdGXYLayer, java.lang.String)