Package cz.vutbr.fit.layout.segm.op

Class SuperAreaOperator

java.lang.Object

cz.vutbr.fit.layout.impl.BaseService

cz.vutbr.fit.layout.impl.BaseParametrizedOperation

cz.vutbr.fit.layout.impl.BaseOperator

cz.vutbr.fit.layout.segm.op.SuperAreaOperator

All Implemented Interfaces:

AreaTreeOperator, ParametrizedOperation, Service

Direct Known Subclasses:

GroupByDOMOperator, HomogeneousLeafOperator

public class SuperAreaOperator
extends BaseOperator

Detects the larger visual areas and creates the artificial area nodes.

Author:

burgetr

Field Summary

Fields

Modifier and Type	Field	Description
protected int	depthLimit	Recursion depth limit while detecting the sub-areas

Constructor Summary

Constructors

Constructor	Description
SuperAreaOperator()	Creates the deparator with default parameter values.
SuperAreaOperator(int depthLimit)	Creates the operator.

Method Summary

Modifier and Type	Method	Description
void	apply(AreaTree atree)	Applies the operation to the given tree.
void	apply(AreaTree atree, Area root)	Applies the operation to the given subtree of the tree.
protected GroupAnalyzer	createGroupAnalyzer(Area root)
List<Parameter>	defineParams()	Creates the parameter definition for this operation.
void	findSuperAreas(Area root, int passlimit)	Creates syntetic super areas by grouping the subareas of the given area.
String	getCategory()	A category that allows to group similar services.
int	getDepthLimit()
String	getDescription()	Obtains a longer description of the service.
String	getId()	Obtains a unique ID of the service
String	getName()	Obtains a descriptive name of the service that may be presented to the user.
void	setDepthLimit(int depthLimit)

Methods inherited from class cz.vutbr.fit.layout.impl.BaseOperator

toString

Methods inherited from class cz.vutbr.fit.layout.impl.BaseParametrizedOperation

getParam, getParams, getParamString, setParam

Methods inherited from class cz.vutbr.fit.layout.impl.BaseService

getServiceManager, setServiceManager

Methods inherited from class java.lang.Object

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

Methods inherited from interface cz.vutbr.fit.layout.api.ParametrizedOperation

getParam, getParams, getParamString, setParam

Methods inherited from interface cz.vutbr.fit.layout.api.Service

setServiceManager

Field Detail

depthLimit

protected int depthLimit

Recursion depth limit while detecting the sub-areas

Constructor Detail

SuperAreaOperator

public SuperAreaOperator()

Creates the deparator with default parameter values.

SuperAreaOperator

public SuperAreaOperator(int depthLimit)

Creates the operator.

Parameters:

depthLimit - Recursion depth limit while detecting the sub-areas

Method Detail

getId

public String getId()

Description copied from interface: Service

Obtains a unique ID of the service

getName

public String getName()

Description copied from interface: Service

Obtains a descriptive name of the service that may be presented to the user.

Returns:

the operator name

getDescription

public String getDescription()

Description copied from interface: Service

Obtains a longer description of the service.

Returns:

the description

getCategory

public String getCategory()

Description copied from interface: Service

A category that allows to group similar services.

Returns:

Category name or null when no category is assigned.

defineParams

public List<Parameter> defineParams()

Description copied from class: BaseParametrizedOperation

Creates the parameter definition for this operation.

Overrides:

defineParams in class BaseParametrizedOperation

Returns:

The list of parameters.

getDepthLimit

public int getDepthLimit()

setDepthLimit

public void setDepthLimit(int depthLimit)

apply

public void apply(AreaTree atree)

Description copied from interface: AreaTreeOperator

Applies the operation to the given tree.

Parameters:

atree - the area tree to be modified.

apply

public void apply(AreaTree atree,
                  Area root)

Description copied from interface: AreaTreeOperator

Applies the operation to the given subtree of the tree.

Parameters:

atree - the area tree to be modified.

root - the root node of the affected subtree.

createGroupAnalyzer

protected GroupAnalyzer createGroupAnalyzer(Area root)

findSuperAreas

public void findSuperAreas(Area root,
                           int passlimit)

Creates syntetic super areas by grouping the subareas of the given area.

Parameters:

root - the root area to be processed

passlimit - the maximal number of passes while some changes occur