org.fit.segm.grouping

Class Provider

java.lang.Object

org.fit.layout.impl.BaseParametrizedOperation

org.fit.layout.impl.BaseAreaTreeProvider

org.fit.segm.grouping.Provider

All Implemented Interfaces:

AreaTreeProvider, ParametrizedOperation, Service

public class Provider
extends BaseAreaTreeProvider

An AreaTreeProvider for the default FitLayout Segmentation algorithm based on grouping.

Author:

burgetr

Nested Class Summary

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

ParametrizedOperation.ValueType

Constructor Summary

Constructors

Constructor and Description
Provider()

Method Summary

Methods

Modifier and Type	Method and Description
AreaTree	createAreaTree(Page page) Creates a basic area tree from the given page.
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.

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

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

Constructor Detail

Provider

public Provider()

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

createAreaTree

public AreaTree createAreaTree(Page page)

Description copied from interface: AreaTreeProvider

Creates a basic area tree from the given page. The details depend on the particular algorithm. The obtained tree may be further processed by the area tree operators.

Parameters:

page - the page to be processed

Returns:

a tree of areas

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