ilog.views.maps.symbology.swing

Class IlvPersistentSDMModelProperty

java.lang.Object

ilog.views.IlvNamedProperty

ilog.views.maps.symbology.swing.IlvPersistentSDMModelProperty

All Implemented Interfaces:

IlvPersistentObject, Serializable

public class IlvPersistentSDMModelProperty
extends IlvNamedProperty

This class is a named property, attached to an IlvSDMEngine instance, which will store symbol model data when the map is saved. When the data is loaded, it will replace the symbol model attached to the tree view, creating symbols through the tree view action methods and setting up the properties of the symbol with what was saved. You should not create an instance of that class directly, but rather use the GetPersistentSDMModel(IlvSDMEngine, IlvPersistentSDMNodeFactory, boolean) factory method.

Since:

JViews 8.5

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvPersistentSDMModelProperty(IlvInputStream stream) Creates a new SymbolModelProperty.

Method Summary

Modifier and Type	Method and Description
protected void	attach(IlvSDMEngine engine) Attaches the engine to the property.
IlvNamedProperty	copy() Copies the named property.
static IlvPersistentSDMModelProperty	GetPersistentSDMModel(IlvSDMEngine engine, IlvPersistentSDMNodeFactory symbolFactory, boolean listenToChanges) Finds or creates a persistent model and stores it as a property of the engine manager.
IlvPersistentSDMModelXMLConnector	getXMLConnector() Returns the IlvPersistentSDMModelXMLConnector that reads and writes data.
boolean	isPersistent() Tells if the property must be saved to an IVL file.
void	setXMLConnector(IlvPersistentSDMModelXMLConnector connector) Overrides the IlvXMLConnector that reads and writes data.
void	write(IlvOutputStream stream) Writes the property to 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

Constructor Detail

IlvPersistentSDMModelProperty

public IlvPersistentSDMModelProperty(IlvInputStream stream)
                              throws IlvReadFileException

Creates a new SymbolModelProperty.

Parameters:

stream -

Throws:

IlvReadFileException

Method Detail

write

public void write(IlvOutputStream stream)
           throws IOException

Writes the property to an IlvOutputStream. You must override this method if specific data is to be stored. Note that the first instruction in your implementation of the method must be super.write(stream).

Specified by:

write in interface IlvPersistentObject

Overrides:

write in class IlvNamedProperty

Parameters:

stream - the output stream.

Throws:

IOException - standard IO error.

See Also:

IlvNamedProperty.write(ilog.views.io.IlvOutputStream)

getXMLConnector

public IlvPersistentSDMModelXMLConnector getXMLConnector()

Returns the IlvPersistentSDMModelXMLConnector that reads and writes data.

Returns:

The IlvPersistentSDMModelXMLConnector that reads and writes data

setXMLConnector

public void setXMLConnector(IlvPersistentSDMModelXMLConnector connector)

Overrides the IlvXMLConnector that reads and writes data.

Parameters:

connector - The XML connector.

copy

public IlvNamedProperty copy()

Copies the named property. Note that when a graphic object is copied (method copy), the named properties associated with this object are also copied using this method. The only way to avoid the copy is to return null in this method.

Specified by:

copy in class IlvNamedProperty

See Also:

IlvNamedProperty.copy()

isPersistent

public boolean isPersistent()

Tells if the property must be saved to an IVL file. If this method returns true, the property is saved; otherwise it is not saved.

Specified by:

isPersistent in class IlvNamedProperty

See Also:

IlvNamedProperty.isPersistent()

GetPersistentSDMModel

public static IlvPersistentSDMModelProperty GetPersistentSDMModel(IlvSDMEngine engine,
                                                                  IlvPersistentSDMNodeFactory symbolFactory,
                                                                  boolean listenToChanges)

Finds or creates a persistent model and stores it as a property of the engine manager.

Parameters:

engine - The SDM Engine

symbolFactory - A factory used to create and store model nodes

listenToChanges - If true, this will additionally attach a listener that changes the engine model whenever the property changes (for example, when a new value is read from a file).

Returns:

The persistent symbol model

attach

protected void attach(IlvSDMEngine engine)

Attaches the engine to the property. This will either change the engine model to the one set for this property or read the saved XML data into the engine.

Parameters:

engine - The SDM engine to attach.