ilog.views.maps

Class IlvMapLayerProperty

java.lang.Object

ilog.views.IlvNamedProperty

ilog.views.maps.IlvMapLayerProperty

All Implemented Interfaces:

IlvPersistentObject, Serializable

public class IlvMapLayerProperty
extends IlvNamedProperty

A IlvNamedProperty used to retrieve an IlvMapLayer from an IlvManagerLayer. To retrieve a IlvMapLayer from an IlvManagerLayer you can use the following code:

 IlvManagerLayer layer = ...
 IlvMapLayerProperty p = 
   (IlvMapLayerProperty)layer.getNamedProperty(IlvMapLayerProperty.NAME);
 if(p != null) {
   IlvMapLayer mapLayer = p.getMapLayer();
   ....
 }
 

Since:

JViews 7.5

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME The name of the named property.

Constructor Summary

Constructors

Constructor and Description
IlvMapLayerProperty(IlvInputStream stream) Reads a IlvMapLayerProperty from an IlvInputStream
IlvMapLayerProperty(IlvMapLayer layer) Creates a IlvMapLayerProperty
IlvMapLayerProperty(IlvMapLayerProperty source) Creates a IlvMapLayerProperty by copying an existing one.

Method Summary

Modifier and Type	Method and Description
IlvNamedProperty	copy() Returns a copy of this property.
IlvMapLayer	getMapLayer() Retrieves the value of this property.
static IlvMapLayer	getMapLayer(IlvManagerLayer managerLayer) Retrieves the value of a IlvMapLayerProperty attached to a IlvManagerLayer if any.
boolean	isPersistent() Tells if this property is persistent.
void	write(IlvOutputStream stream) Write this property into on IlvMapOutputStream

Methods inherited from class ilog.views.IlvNamedProperty

getName

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

The name of the named property.

See Also:

Constant Field Values

Constructor Detail

IlvMapLayerProperty

public IlvMapLayerProperty(IlvInputStream stream)
                    throws IlvReadFileException

Reads a IlvMapLayerProperty from an IlvInputStream

Parameters:

stream - The stream to read from.

Throws:

IlvReadFileException

IlvMapLayerProperty

public IlvMapLayerProperty(IlvMapLayer layer)

Creates a IlvMapLayerProperty

Parameters:

layer - The IlvMapLayer

IlvMapLayerProperty

public IlvMapLayerProperty(IlvMapLayerProperty source)

Creates a IlvMapLayerProperty by copying an existing one.

Parameters:

source - The property to copy.

Method Detail

copy

public IlvNamedProperty copy()

Returns a copy of this property.

Specified by:

copy in class IlvNamedProperty

Returns:

A copy of this property.

isPersistent

public boolean isPersistent()

Tells if this property is persistent.

Specified by:

isPersistent in class IlvNamedProperty

Returns:

true since this property is persistent.

write

public void write(IlvOutputStream stream)
           throws IOException

Write this property into on IlvMapOutputStream

Specified by:

write in interface IlvPersistentObject

Overrides:

write in class IlvNamedProperty

Parameters:

stream - The stream to write to.

Throws:

IOException

getMapLayer

public IlvMapLayer getMapLayer()

Retrieves the value of this property.

Returns:

The value of this property, which is an IlvMapLayer

getMapLayer

public static IlvMapLayer getMapLayer(IlvManagerLayer managerLayer)

Retrieves the value of a IlvMapLayerProperty attached to a IlvManagerLayer if any.

Parameters:

managerLayer - The IlvManagerLayer to retrieve the property from.

Returns:

The attached IlvMapLayer or null.