org.fit.layout.api

Interface ParametrizedOperation

All Known Subinterfaces:

AreaTreeOperator, AreaTreeProvider, BoxTreeProvider, LogicalTreeProvider

All Known Implementing Classes:

BaseAreaTreeProvider, BaseBoxTreeProvider, BaseLogicalTreeProvider, BaseOperator, BaseParametrizedOperation, CollapseAreasOperator, CSSBoxTreeProvider, FindLineOperator, HomogeneousLeafOperator, LayoutSplitOperator, LogicalTreeBuilder, MultiLineOperator, Provider, SortByLinesOperator, SortByPositionOperator, SuperAreaOperator, TagEntitiesOperator, VisualClassificationOperator, XMLOutputOperator

public interface ParametrizedOperation

An implementation of an operation with external parametres of different types.

Author:

burgetr

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ParametrizedOperation.ValueType Possible parameter value types

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	getParam(java.lang.String name) Obtains the value of the given parameter.
java.lang.String[]	getParamNames() Obtains a list of available parameter names of the operation.
java.lang.Object[]	getParamRange(java.lang.String name) Obtains the minimal and maximal value of the given parameter.
ParametrizedOperation.ValueType[]	getParamTypes() Obtains a list of available parameter value types.
boolean	setParam(java.lang.String name, java.lang.Object value) Sets the value of the given parameter.

Method Detail

getParamNames

java.lang.String[] getParamNames()

Obtains a list of available parameter names of the operation.

Returns:

an array of parameter names

getParamTypes

ParametrizedOperation.ValueType[] getParamTypes()

Obtains a list of available parameter value types.

Returns:

an array of value types

setParam

boolean setParam(java.lang.String name,
               java.lang.Object value)

Sets the value of the given parameter.

Parameters:

name - parameter name

value - parameter value

Returns:

true when successfully set, false for unknown parameter or invalid value

getParam

java.lang.Object getParam(java.lang.String name)

Obtains the value of the given parameter.

Parameters:

name - the parameter name

Returns:

the parameter value or null for unknown parameter

getParamRange

java.lang.Object[] getParamRange(java.lang.String name)

Obtains the minimal and maximal value of the given parameter.

Parameters:

name - the name of the parameter

Returns:

Array of two objects [min, max] for numeric types, [min_length, max_length] for string types, null for other types or non-existing parameters