ilog.views.maps.symbology.swing

Interface IlvPersistentSDMNodeFactory

All Known Subinterfaces:

IlvSymbologyTreeViewActions

All Known Implementing Classes:

IlvAbstractGroupTreeViewActions, IlvApp6aSymbologyTreeViewActions

public interface IlvPersistentSDMNodeFactory

Interface passed to an IlvPersistentSDMModelProperty, that indicates the way model nodes should be created. Usually creating a symbol is dependent on some application context. This interface also includes methods to manage that persistent context.

Since:

JViews 8.5

Method Summary

Modifier and Type	Method and Description
IlvPersistentObject	getPersistentContext() Returns the context that should persist with the model.
boolean	isPropertyIgnored(IlvSDMModel model, Object node, String name) Indicates whether a property that is saved should be ignored at read time.
Object	newSymbol(String tag) This method will be called when a node needs to be created at read time.
void	setPersistentContext(IlvPersistentObject context) Sets the context that has persisted with the model.

Method Detail

newSymbol

Object newSymbol(String tag)

This method will be called when a node needs to be created at read time. It should return a new valid node, that will later be added to the model. Here is a simple sample implementation:

 public void newSymbol(String tag) {
   return(new IlvDefaultSDMNode(tag));
 }
 

Parameters:

tag - The tag to be used for the new symbol.

Returns:

A new symbol

isPropertyIgnored

boolean isPropertyIgnored(IlvSDMModel model,
                          Object node,
                          String name)

Indicates whether a property that is saved should be ignored at read time.

Parameters:

model - Model impacted

node - Node for which the property needs to be changed

name - Name of the property

Returns:

true If the value read for that property should be ignored If you use properties that are not convertible by SDM (objects), their string representation is saved in the model. You can use this method to prevent the string from overriding the value that was set through newSymbol(String) at read time.

getPersistentContext

IlvPersistentObject getPersistentContext()

Returns the context that should persist with the model. The persistent object returned should be created or updated at this point. This method can return null if nothing needs to be persistent.

Returns:

action data that should persist with the model to be able to re-create nodes.

setPersistentContext

void setPersistentContext(IlvPersistentObject context)

Sets the context that has persisted with the model. The factory information should be updated with what is stored in the context.

Parameters:

context - The data that has persisted with the model