ilog.views.maps.beans
Class IlvMapAnnotationProperty

java.lang.Object
  ilog.views.IlvNamedProperty
      ilog.views.maps.beans.IlvMapAnnotationProperty

All Implemented Interfaces:

IlvPersistentObject, Serializable

public class IlvMapAnnotationProperty
extends IlvNamedProperty

A property used to store and retrieve annotations information.

Since:

JViews 8.0

See Also:

Serialized Form

Field Summary

static String

NAME The name of the property.

Constructor Summary

IlvMapAnnotationProperty(IlvInputStream stream)
Reads an IlvMapAnnotationProperty from an IlvInputStream.

IlvMapAnnotationProperty(IlvMapAnnotationModel model)
Creates an IlvMapAnnotationProperty from an IlvMapAnnotationModel.

IlvMapAnnotationProperty(IlvMapAnnotationProperty source)
Creates an IlvMapAnnotationProperty by copying an existing one.

Method Summary

IlvNamedProperty	copy() Returns a copy of this property.
IlvMapAnnotationModel	getMapAnnotationModel() Retrieves the value of this property.
static IlvMapAnnotationModel	GetMapAnnotationModel(IlvManager manager) Retrieves the value of an IlvMapAnnotationProperty attached to an IlvManager.
boolean	isPersistent() Indicates if this property is persistent.
void	write(IlvOutputStream stream) Write this property into an 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 property.

See Also:

Constant Field Values

Constructor Detail

IlvMapAnnotationProperty

public IlvMapAnnotationProperty(IlvMapAnnotationModel model)

Creates an IlvMapAnnotationProperty from an IlvMapAnnotationModel.

Parameters:

model - The value of this property.

IlvMapAnnotationProperty

public IlvMapAnnotationProperty(IlvMapAnnotationProperty source)

Creates an IlvMapAnnotationProperty by copying an existing one.

Parameters:

source - The property to copy.

IlvMapAnnotationProperty

public IlvMapAnnotationProperty(IlvInputStream stream)
                         throws IlvReadFileException

Reads an IlvMapAnnotationProperty from an IlvInputStream.

Parameters:

stream - The stream to be read from.

Throws:

IlvReadFileException

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()

Indicates 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 an IlvMapOutputStream.

Specified by:

write in interface IlvPersistentObject

Overrides:

write in class IlvNamedProperty

Parameters:

stream - The stream to write to.

Throws:

IOException

getMapAnnotationModel

public IlvMapAnnotationModel getMapAnnotationModel()

Retrieves the value of this property.

Returns:

The value of this property, which is an IlvMapAnnotationModel.

GetMapAnnotationModel

public static IlvMapAnnotationModel GetMapAnnotationModel(IlvManager manager)

Retrieves the value of an IlvMapAnnotationProperty attached to an IlvManager. If no property has been set for this manager, a new one is created and attached to the given manager.

Parameters:

manager - The IlvManager from which to retrieve the property.

Returns:

The attached IlvMapAnnotationModel or null.