Package com.luciad.view.lightspeed.label.algorithm.discrete

Class TLspDependentLabelsRemovalWrapper

java.lang.Object

com.luciad.view.lightspeed.label.algorithm.discrete.ALspDiscreteLabelingAlgorithm

com.luciad.view.lightspeed.label.algorithm.discrete.ALspDiscreteLabelingAlgorithmWrapper

com.luciad.view.lightspeed.label.algorithm.discrete.TLspDependentLabelsRemovalWrapper

All Implemented Interfaces:

ILcdCloneable, ILspLabelingAlgorithm, Cloneable

public class TLspDependentLabelsRemovalWrapper
extends ALspDiscreteLabelingAlgorithmWrapper

This wrapper uses a dependency relation between labels to add extra behavior to the placement. When representation 1 depends on a representation 2, and representation 2 is removed from the results, representation 1 is also removed.

It is also possible to define circular dependencies, e.g. representation 1 and representation 2 depend on each other. When representation 1 is removed, representation 2 is also removed, and vice versa.

This wrapper only supports dependencies between representations from the same object. Not respecting this will cause this wrapper to work incorrectly, i.e. representation that should disappear will not always disappear.

This wrapper works best when the labels returned by the label iterator of the delegate algorithm are ordered as follows :

• Clusters of labels should are kept together. If one representation of a representation cluster is returned, others should follow right after.
• Labels that depend on another label should be returned after it.

Not having this order doesn't stop the wrapper from working correctly. However the placement will not be optimal : more representations may be dropped than necessary.

Since:

2012.0

Nested Class Summary

Nested classes/interfaces inherited from interface com.luciad.view.lightspeed.label.algorithm.ILspLabelingAlgorithm

ILspLabelingAlgorithm.LabelContext

Field Summary

Fields inherited from class com.luciad.view.lightspeed.label.algorithm.discrete.ALspDiscreteLabelingAlgorithm

CONSECUTIVE_LABEL_CONFLICT_FAIL_COUNT_KEY, CONSECUTIVE_LABEL_FAIL_COUNT_KEY, LABEL_ATTEMPT_COUNT_KEY, LABEL_CONFLICT_FAIL_COUNT_KEY, LABEL_FAIL_COUNT_KEY, LABEL_PLACED_COUNT_KEY, TOTAL_LABEL_COUNT_KEY

Constructor Summary

Constructors

Constructor	Description
TLspDependentLabelsRemovalWrapper(ALspDiscreteLabelingAlgorithm aDelegate, ILspLabelDependencyProvider aDependencyProvider)	Creates a new wrapper for the given algorithm, with the given dependency provider.

Method Summary

Modifier and Type	Method	Description
protected Iterator<TLspLabelID>	createLabelIterator(List<TLspLabelID> aLabels, ILspLabelingAlgorithm.LabelContext aLabelContext, ILspLabelConflictChecker aConflictChecker, ILspView aView)	Creates a new Iterator that iterates over the TLspLabelIDs.
protected ILspLabelPlacementEvaluator	createLabelPlacementEvaluator(List<TLspLabelID> aLabels, ILspLabelingAlgorithm.LabelContext aLabelContext, ILspLabelConflictChecker aConflictChecker, ILspView aView)	Creates a new ILspLabelPlacementEvaluator using the given parameters.
ILspLabelDependencyProvider	getDependencyProvider()	Returns the dependency provider used to define the dependency relation between the representations.
void	setDependencyProvider(ILspLabelDependencyProvider aDependencyProvider)	Sets the dependency provider used to define the dependency relation between the representations.

Methods inherited from class com.luciad.view.lightspeed.label.algorithm.discrete.ALspDiscreteLabelingAlgorithmWrapper

createLabelPlacementIterator, getDelegate, getQuality, setQuality

Methods inherited from class com.luciad.view.lightspeed.label.algorithm.discrete.ALspDiscreteLabelingAlgorithm

clone, placeLabels

Methods inherited from class java.lang.Object

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

Constructor Details

TLspDependentLabelsRemovalWrapper

public TLspDependentLabelsRemovalWrapper(ALspDiscreteLabelingAlgorithm aDelegate,
 ILspLabelDependencyProvider aDependencyProvider)

Creates a new wrapper for the given algorithm, with the given dependency provider. When calling ILspLabelDependencyProvider.getDependingLabels, the returned representations are those representations that depend on the given representation, i.e. if the given representation is removed, the returned representations are also removed.

Parameters:

aDelegate - the delegate algorithm.

aDependencyProvider - a dependency provider.

Method Details

getDependencyProvider

public ILspLabelDependencyProvider getDependencyProvider()

Returns the dependency provider used to define the dependency relation between the representations. When calling ILspLabelDependencyProvider.getDependingLabels, the returned representations are those representations that depend on the given representation, i.e. if the given representation is removed, the returned representations are also removed.

Returns:

the dependency provider used to define the dependency relation between the representations.

setDependencyProvider

public void setDependencyProvider(ILspLabelDependencyProvider aDependencyProvider)

Sets the dependency provider used to define the dependency relation between the representations. When calling ILspLabelDependencyProvider.getDependingLabels, the returned representations are those representations that depend on the given representation, i.e. if the given representation is removed, the returned representations are also removed.

Parameters:

aDependencyProvider - the dependency provider used to define the dependency relation between the representations.

createLabelIterator

protected Iterator<TLspLabelID> createLabelIterator(List<TLspLabelID> aLabels,
 ILspLabelingAlgorithm.LabelContext aLabelContext,
 ILspLabelConflictChecker aConflictChecker,
 ILspView aView)

Description copied from class: ALspDiscreteLabelingAlgorithm

Creates a new Iterator that iterates over the TLspLabelIDs. The abstract algorithm will continue iterating over TLspLabelIDs as long as Iterator.hasNext() returns true. When it returns false, no more label placements will be tried, and placeLabels returns. Iterator.hasNext() should always be called before calling Iterator.next(), and if it returns true, Iterator.next() should never return null.

The implementation of this method should be as independent as possible. It should not rely on createLabelPlacementIterator or createLabelPlacementEvaluator. Not respecting this might result in unexpected behaviour when wrapping or extending this class.

Override this method to provide a custom implementation.

Overrides:

createLabelIterator in class ALspDiscreteLabelingAlgorithmWrapper

Parameters:

aLabels - a list of labels that need to be placed.

aLabelContext - the label info object.

aConflictChecker - the conflict checker to be used when evaluating placements.

aView - the view.

Returns:

a new Iterator that iterates over TLspLabelIDs.

createLabelPlacementEvaluator

protected ILspLabelPlacementEvaluator createLabelPlacementEvaluator(List<TLspLabelID> aLabels,
 ILspLabelingAlgorithm.LabelContext aLabelContext,
 ILspLabelConflictChecker aConflictChecker,
 ILspView aView)

Description copied from class: ALspDiscreteLabelingAlgorithm

Creates a new ILspLabelPlacementEvaluator using the given parameters. It evaluates the placements returned by createLabelPlacementIterator, and returns a PlacementResult to denote if the placement should be used for its label or not.

The following actions are undertaken for the following placement results :

• PlacementResult.SUCCESS : the given placement will be used for its label, it will be added to the list of placed representations, and it will be added to the given ILspLabelConflictChecker. After that, ILspLabelPlacementEvaluator.placementApplied will be called and no more placements are tried for the label.
• PlacementResult.FALLBACK : the abstract algorithm will try to find an other placements which returns PlacementResult.SUCCESS. When no such placement is found, this placement will be added to the list of placed labels, and it will be added to the given ILspLabelConflictChecker. After that, ILspLabelPlacementEvaluator.placementApplied will be called.
• PlacementResult.TRY_NEW_PLACEMENT : the abstract algorithm will try to find an other placement which returns PlacementResult.SUCCESS or PlacementResult.FALLBACK. When no such placement is found, ILspLabelPlacementEvaluator.noPlacementApplied is called.
• PlacementResult.FAILED : the abstract algorithm will immediately call ILspLabelPlacementEvaluator.noPlacementApplied and will not try to find other placements for the label.

Override this method to provide a custom implementation.

Overrides:

createLabelPlacementEvaluator in class ALspDiscreteLabelingAlgorithmWrapper

Parameters:

aLabels - a list of labels.

aLabelContext - the label info object.

aConflictChecker - the conflict checker to be used when evaluating placements.

aView - the view

Returns:

a new ILspLabelPlacementEvaluator.

See Also:

• ILspLabelPlacementEvaluator