com.yworks.yfiles.layout

Class ItemMapping<TItem,TValue>

java.lang.Object

com.yworks.yfiles.layout.ItemMapping<TItem,TValue>

Type Parameters:

TItem - The type of the items that are mapped.

TValue - The type of the values the items are mapped to.

Direct Known Subclasses:

ContextItemMapping

public class ItemMapping<TItem,TValue>
extends Object

Provides different ways to define a mapping from items to values for use with LayoutData.

Only one of the provided ways to define a mapping can be used at the same time, therefore only one of the properties Mapper, Delegate and Constant should be set on each instance.

This class supports LayoutData implementations and does not usually have to be used explicitly.

Constructor Summary

Constructors

Constructor and Description
ItemMapping()

Method Summary

Modifier and Type	Method and Description
TValue	getConstant() Gets a constant value all items are mapped to.
Function<TItem,TValue>	getDelegate() Gets a delegate that implements the mapping.
IMapper<TItem,TValue>	getMapper() Gets an IMapper that realizes the mapping.
IMapper<TItem,TValue>	provideMapper(LayoutGraphAdapter adapter, ILayoutAlgorithm layout) Provides a mapper mapping the items to values.
void	setConstant(TValue value) Sets a constant value all items are mapped to.
void	setDelegate(Function<TItem,TValue> value) Sets a delegate that implements the mapping.
void	setMapper(IMapper<TItem,TValue> value) Sets an IMapper that realizes the mapping.

Methods inherited from class java.lang.Object

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

Constructor Detail

ItemMapping

public ItemMapping()

Method Detail

getConstant

public final TValue getConstant()

Gets a constant value all items are mapped to.

Returns:

The Constant.

See Also:

setConstant(java.lang.Object)

getDelegate

public final Function<TItem,TValue> getDelegate()

Gets a delegate that implements the mapping.

Returns:

The Delegate.

See Also:

setDelegate(Function)

getMapper

public final IMapper<TItem,TValue> getMapper()

Gets an IMapper that realizes the mapping.

Returns:

The Mapper.

See Also:

setMapper(IMapper)

provideMapper

public IMapper<TItem,TValue> provideMapper(LayoutGraphAdapter adapter,
                                           ILayoutAlgorithm layout)

Provides a mapper mapping the items to values.

Parameters:

adapter - The graph adapter the mapper shall be provided for.

layout - The layout using the mapper.

Returns:

A mapper mapping the items to values.

setConstant

public final void setConstant(TValue value)

Sets a constant value all items are mapped to.

Parameters:

value - The Constant to set.

See Also:

getConstant()

setDelegate

public final void setDelegate(Function<TItem,TValue> value)

Sets a delegate that implements the mapping.

Parameters:

value - The Delegate to set.

See Also:

getDelegate()

setMapper

public final void setMapper(IMapper<TItem,TValue> value)

Sets an IMapper that realizes the mapping.

Parameters:

value - The Mapper to set.

See Also:

getMapper()