com.yworks.yfiles.graphml

Class CreationProperties

java.lang.Object

com.yworks.yfiles.graphml.CreationProperties

All Implemented Interfaces:

IMapper<Object,Object>

public class CreationProperties
extends Object
implements IMapper<Object,Object>

A simple mutable implementation of IMapper that is typed for Object keys and values.

This class is used by the GraphMLParser to store properties of an item before it has been created. An instance of this class can be found in the ILookup.lookup(java.lang.Class) of the IParseContext during the parsing of an item. Custom parsers may populate the dictionary with various properties that can then be used by the IGraphElementFactory during the creation of the item.

See Also:

IGraphElementFactory, GraphMLParser

Field Summary

Fields

Modifier and Type	Field and Description
static String	BENDS Creation property key that tags bend information.
static String	IS_GROUP_NODE Creation property key that tags group node information.
static String	LABELS Creation property key that tags label information.
static String	LAYOUT Creation property key that tags node layout information.
static String	PORT_LOCATION_MODEL_PARAMETER Creation property key that tags port location information.
static String	STYLE Creation property key that tags style information.
static String	TAG Creation property key that tags tag object information.

Constructor Summary

Constructors

Constructor and Description
CreationProperties()

Method Summary

Modifier and Type	Method and Description
void	clear() Clears all entries from this property store.
Iterable<Map.Entry<Object,Object>>	getEntries() Gets all the entries stored by this instance.
Object	getValue(Object key) Gets the value associated with the specified key.
void	removeValue(Object key) Removes the associated entry for the given key.
void	setValue(Object key, Object value) Sets the value associated with the specified key.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.yworks.yfiles.graph.IMapper

fromConstant, fromFunction

Field Detail

BENDS

public static final String BENDS

Creation property key that tags bend information.

Stores values of type Iterable with IBend template instances.

See Also:

IGraphElementFactory.createEdge(com.yworks.yfiles.graphml.IParseContext, com.yworks.yfiles.graph.INode, com.yworks.yfiles.graph.IPort, com.yworks.yfiles.graph.INode, com.yworks.yfiles.graph.IPort), Constant Field Values

IS_GROUP_NODE

public static final String IS_GROUP_NODE

Creation property key that tags group node information.

Stores values of type Boolean.

See Also:

IGraphElementFactory.createNode(com.yworks.yfiles.graphml.IParseContext), Constant Field Values

LABELS

public static final String LABELS

Creation property key that tags label information.

Stores values of type Iterable with ILabel template instances.

See Also:

IGraphElementFactory, Constant Field Values

LAYOUT

public static final String LAYOUT

Creation property key that tags node layout information.

Stores values of type RectD.

See Also:

IGraphElementFactory.createNode(com.yworks.yfiles.graphml.IParseContext), Constant Field Values

PORT_LOCATION_MODEL_PARAMETER

public static final String PORT_LOCATION_MODEL_PARAMETER

Creation property key that tags port location information.

Stores values of type IPortLocationModelParameter.

See Also:

IGraphElementFactory.addPort(com.yworks.yfiles.graphml.IParseContext, com.yworks.yfiles.graph.IPortOwner), Constant Field Values

STYLE

public static final String STYLE

Creation property key that tags style information.

Stores values of type INodeStyle, IEdgeStyle, and IPortStyle respectively.

See Also:

IGraphElementFactory, Constant Field Values

TAG

public static final String TAG

Creation property key that tags tag object information.

Stores values of type Object.

See Also:

IGraphElementFactory, Constant Field Values

Constructor Detail

CreationProperties

public CreationProperties()

Method Detail

clear

public final void clear()

Clears all entries from this property store.

getEntries

public final Iterable<Map.Entry<Object,Object>> getEntries()

Gets all the entries stored by this instance.

Returns:

The entries.

getValue

public final Object getValue(Object key)

Gets the value associated with the specified key.

Specified by:

getValue in interface IMapper<Object,Object>

Parameters:

key - The key.

Returns:

The value stored for the key.

See Also:

setValue(Object, Object)

removeValue

public final void removeValue(Object key)

Removes the associated entry for the given key.

Parameters:

key - The entry key to remove.

setValue

public final void setValue(Object key,
                           Object value)

Sets the value associated with the specified key.

Specified by:

setValue in interface IMapper<Object,Object>

Parameters:

key - The key.

value - The value stored for the key.

See Also:

getValue(Object)