org.fit.segm.grouping.op

Class SortByLinesOperator

java.lang.Object

org.fit.layout.impl.BaseParametrizedOperation

org.fit.layout.impl.BaseOperator

org.fit.segm.grouping.op.SortByPositionOperator

org.fit.segm.grouping.op.SortByLinesOperator

All Implemented Interfaces:

AreaTreeOperator, ParametrizedOperation, Service

public class SortByLinesOperator
extends SortByPositionOperator

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 java.lang.String[]	paramNames
protected ParametrizedOperation.ValueType[]	paramTypes

Fields inherited from class org.fit.segm.grouping.op.SortByPositionOperator

columnFirst

Constructor Summary

Constructors

Constructor and Description
SortByLinesOperator()

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.
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	recursiveSortLines(AreaImpl root) Goes through all the areas in the tree and sorts their sub-areas.
protected void	sortChildLines(AreaImpl root) Goes through the grid of areas and sorts the adjacent visual areas that are not separated by anything

Methods inherited from class org.fit.segm.grouping.op.SortByPositionOperator

getColumnFirst, recursivelySortChildAreas, setColumnFirst

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

paramNames

protected final java.lang.String[] paramNames

paramTypes

protected final ParametrizedOperation.ValueType[] paramTypes

Constructor Detail

SortByLinesOperator

public SortByLinesOperator()

Method Detail

getId

public java.lang.String getId()

Description copied from interface: Service

Obtains a unique ID of the service

Specified by:

getId in interface Service

Overrides:

getId in class SortByPositionOperator

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.

Specified by:

getName in interface Service

Overrides:

getName in class SortByPositionOperator

Returns:

the operator name

getDescription

public java.lang.String getDescription()

Description copied from interface: Service

Obtains a longer description of the service.

Specified by:

getDescription in interface Service

Overrides:

getDescription in class SortByPositionOperator

Returns:

the description

getParamNames

public java.lang.String[] getParamNames()

Description copied from interface: ParametrizedOperation

Obtains a list of available parameter names of the operation.

Specified by:

getParamNames in interface ParametrizedOperation

Overrides:

getParamNames in class SortByPositionOperator

Returns:

an array of parameter names

getParamTypes

public ParametrizedOperation.ValueType[] getParamTypes()

Description copied from interface: ParametrizedOperation

Obtains a list of available parameter value types.

Specified by:

getParamTypes in interface ParametrizedOperation

Overrides:

getParamTypes in class SortByPositionOperator

Returns:

an array of value types

apply

public void apply(AreaTree atree)

Description copied from interface: AreaTreeOperator

Applies the operation to the given tree.

Specified by:

apply in interface AreaTreeOperator

Overrides:

apply in class SortByPositionOperator

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.

Specified by:

apply in interface AreaTreeOperator

Overrides:

apply in class SortByPositionOperator

Parameters:

atree - the area tree to be modified.

root - the root node of the affected subtree.

recursiveSortLines

protected void recursiveSortLines(AreaImpl root)

Goes through all the areas in the tree and sorts their sub-areas.

sortChildLines

protected void sortChildLines(AreaImpl root)

Goes through the grid of areas and sorts the adjacent visual areas that are not separated by anything