org.fit.segm.grouping.op

Class SortByPositionOperator

java.lang.Object

org.fit.layout.impl.BaseParametrizedOperation

org.fit.layout.impl.BaseOperator

org.fit.segm.grouping.op.SortByPositionOperator

All Implemented Interfaces:

AreaTreeOperator, ParametrizedOperation, Service

Direct Known Subclasses:

SortByLinesOperator

public class SortByPositionOperator
extends BaseOperator

Author:

burgetr

Nested Class Summary

Nested classes/interfaces inherited from interface org.fit.layout.api.ParametrizedOperation

ParametrizedOperation.ValueType

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	columnFirst
protected java.lang.String[]	paramNames
protected ParametrizedOperation.ValueType[]	paramTypes

Constructor Summary

Constructors

Constructor and Description
SortByPositionOperator()
SortByPositionOperator(boolean columnFirst)

Method Summary

Methods

Modifier and Type	Method and 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.
boolean	getColumnFirst()
java.lang.String	getDescription() Obtains a longer description of the service.
java.lang.String	getId() Obtains a unique ID of the service
java.lang.String	getName() Obtains a descriptive name of the service that may be presented to the user.
java.lang.String[]	getParamNames() Obtains a list of available parameter names of the operation.
ParametrizedOperation.ValueType[]	getParamTypes() Obtains a list of available parameter value types.
protected void	recursivelySortChildAreas(Area root, boolean columnFirst)
void	setColumnFirst(boolean columnFirst)

Methods inherited from class org.fit.layout.impl.BaseOperator

toString

Methods inherited from class org.fit.layout.impl.BaseParametrizedOperation

getParam, getParamRange, setParam

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.fit.layout.api.ParametrizedOperation

getParam, getParamRange, setParam

Field Detail

columnFirst

protected boolean columnFirst

paramNames

protected final java.lang.String[] paramNames

paramTypes

protected final ParametrizedOperation.ValueType[] paramTypes

Constructor Detail

SortByPositionOperator

public SortByPositionOperator()

SortByPositionOperator

public SortByPositionOperator(boolean columnFirst)

Method Detail

getId

public java.lang.String getId()

Description copied from interface: Service

Obtains a unique ID of the service

getName

public java.lang.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 java.lang.String getDescription()

Description copied from interface: Service

Obtains a longer description of the service.

Returns:

the description

getParamNames

public java.lang.String[] getParamNames()

Description copied from interface: ParametrizedOperation

Obtains a list of available parameter names of the operation.

Returns:

an array of parameter names

getParamTypes

public ParametrizedOperation.ValueType[] getParamTypes()

Description copied from interface: ParametrizedOperation

Obtains a list of available parameter value types.

Returns:

an array of value types

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)