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

Class SortByPositionOperator

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.SortByPositionOperator

All Implemented Interfaces:

AreaTreeOperator, ParametrizedOperation, Service

Direct Known Subclasses:

SortByLinesOperator

public class SortByPositionOperator
extends BaseOperator

Author:

burgetr

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	columnFirst

Constructor Summary

Constructors

Constructor	Description
SortByPositionOperator()
SortByPositionOperator(boolean columnFirst)

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.
List<Parameter>	defineParams()	Creates the parameter definition for this operation.
String	getCategory()	A category that allows to group similar services.
boolean	getColumnFirst()
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.
protected void	recursivelySortChildAreas(Area root, boolean columnFirst)
void	setColumnFirst(boolean columnFirst)

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

columnFirst

protected boolean columnFirst

Constructor Detail

SortByPositionOperator

public SortByPositionOperator()

SortByPositionOperator

public SortByPositionOperator(boolean columnFirst)

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.

getColumnFirst

public boolean getColumnFirst()

setColumnFirst

public void setColumnFirst(boolean columnFirst)

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.

recursivelySortChildAreas

protected void recursivelySortChildAreas(Area root,
                                         boolean columnFirst)