com.luciad.lucy.util.context

LuciadLightspeedClass TLcyModelMetaDataContext

java.lang.Object

com.luciad.lucy.util.context.TLcyModelMetaDataContext

public class TLcyModelMetaDataContext
extends Object

This context object defines everything related to the meta data of an ILcdModel. Typically the ILcdModelReference and ILcdModelDescriptor of the ILcdModel will be of interest, but other properties of the ILcdModel could be used as well.

The ILcdLayer and the ILcdView in which the ILcdModel is displayed are optionally provided as well.

Constructor Summary

Constructors

Constructor and Description
TLcyModelMetaDataContext(ILcdModel aModel) Creates a new context object for the meta data of the given ILcdModel, with null for the ILcdLayer and the ILcdView.
TLcyModelMetaDataContext(ILcdModel aModel, ILcdLayer aLayer, ILcdView aView) Creates a new context object for the meta data of the given ILcdModel of the given ILcdLayer.

Method Summary

Modifier and Type	Method and Description
ILcdLayer	getLayer() Returns the layer in which the ILcdModel is displayed.
ILcdModel	getModel() Returns the ILcdModel for which this object provides the meta data context.
ILcdView	getView() Returns the ILcdView in which the ILcdModel is displayed.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TLcyModelMetaDataContext

public TLcyModelMetaDataContext(ILcdModel aModel)

Creates a new context object for the meta data of the given ILcdModel, with null for the ILcdLayer and the ILcdView.

Parameters:

aModel - The ILcdModel for which this object provides the meta data context. This must not be null.

TLcyModelMetaDataContext

public TLcyModelMetaDataContext(ILcdModel aModel,
                                ILcdLayer aLayer,
                                ILcdView aView)

Creates a new context object for the meta data of the given ILcdModel of the given ILcdLayer.

Parameters:

aModel - The ILcdModel for which this object provides the context. This may not be null.

aLayer - The ILcdLayer in which the model is displayed. This may be null if this information is not available.

aView - The ILcdView in which the model is displayed. This may be null if this information is not available.

Method Detail

getModel

public ILcdModel getModel()

Returns the ILcdModel for which this object provides the meta data context.

Returns:

The ILcdModel for which this object provides the meta data context. This will never be null.

getLayer

public ILcdLayer getLayer()

Returns the layer in which the ILcdModel is displayed.

Returns:

The layer in which the ILcdModel is displayed. This may be null.

getView

public ILcdView getView()

Returns the ILcdView in which the ILcdModel is displayed.

Returns:

The ILcdView in which the ILcdModel is displayed. This may be null.

toString

public String toString()

Overrides:

toString in class Object