ilog.views.maps.datasource

Class IlvMapDataSourceProperty

java.lang.Object

ilog.views.IlvNamedProperty

ilog.views.maps.datasource.IlvMapDataSourceProperty

All Implemented Interfaces:

IlvPersistentObject, Serializable

public class IlvMapDataSourceProperty
extends IlvNamedProperty

A named property used to attach an IlvMapDataSourceModel to an IlvManager. The data source model can be retrieved from the manager by using the following code :

 IlvManager manager = ...;
 
 IlvMapDataSourceModel model = 
    IlvMapDataSourceProperty.GetMapDataSourceModel(manager);
 

Note that if no model has been previously attached, a new one is created and attached by calling the GetMapDataSourceModel method.

Since:

JViews 7.5

See Also:

Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
IlvMapDataSourceProperty(IlvInputStream stream) Creates a new IlvNamedProperty from an IlvInputStream.
IlvMapDataSourceProperty(IlvMapDataSourceModel model) Creates a new IlvMapDataSourceProperty.
IlvMapDataSourceProperty(IlvMapDataSourceProperty source) Creates a new IlvMapDataSourceProperty by copying an existing one.

Method Summary

Modifier and Type	Method and Description
IlvNamedProperty	copy() Returns a copy of this property.
IlvMapDataSourceModel	getMapDataSourceModel() Returns the value of this property.
static IlvMapDataSourceModel	GetMapDataSourceModel(IlvManager manager) Gets the IlvMapDataSourceModel attached as an IlvMapDataSourceProperty to the manager.
boolean	isPersistent() Indicates if this property is persistent.
void	write(IlvOutputStream stream) Writes this property into an IlvOutputStream.

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

IlvMapDataSourceProperty

public IlvMapDataSourceProperty(IlvMapDataSourceModel model)

Creates a new IlvMapDataSourceProperty.

Parameters:

model - The value of this property.

IlvMapDataSourceProperty

public IlvMapDataSourceProperty(IlvMapDataSourceProperty source)

Creates a new IlvMapDataSourceProperty by copying an existing one.

Parameters:

source - The origin of the copy.

IlvMapDataSourceProperty

public IlvMapDataSourceProperty(IlvInputStream stream)
                         throws IlvReadFileException

Creates a new IlvNamedProperty from an IlvInputStream.

Parameters:

stream - The input stream from which the property is be read.

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. This property is persistent.

write

public void write(IlvOutputStream stream)
           throws IOException

Writes this property into an IlvOutputStream.

Specified by:

write in interface IlvPersistentObject

Overrides:

write in class IlvNamedProperty

Parameters:

stream - The stream to write to.

Throws:

IOException

getMapDataSourceModel

public IlvMapDataSourceModel getMapDataSourceModel()

Returns the value of this property.

Returns:

The IlvMapDataSource value of the property.

GetMapDataSourceModel

public static IlvMapDataSourceModel GetMapDataSourceModel(IlvManager manager)

Gets the IlvMapDataSourceModel attached as an IlvMapDataSourceProperty to the manager. If no IlvMapDataSourceModel has been attached, a new one is created and attached to the manager.

Parameters:

manager - The manager from which to get the data source.

Returns:

The IlvMapDataSourceModel attached to the manager.