Package cz.vutbr.fit.layout.provider

Class OperatorWrapperProvider

java.lang.Object

cz.vutbr.fit.layout.impl.BaseService

cz.vutbr.fit.layout.impl.BaseParametrizedOperation

cz.vutbr.fit.layout.impl.BaseArtifactService

cz.vutbr.fit.layout.provider.OperatorWrapperProvider

All Implemented Interfaces:

ArtifactService, ParametrizedOperation, Service

public class OperatorWrapperProvider
extends BaseArtifactService

An area tree provider that wraps a single area tree operator. It consumes an area tree applies the given operator with params and produces another area tree.

Author:

burgetr

Constructor Summary

Constructors

Constructor	Description
OperatorWrapperProvider(AreaTreeOperator operator)

Method Summary

Modifier and Type	Method	Description
List<Parameter>	defineParams()	Creates the parameter definition for this operation.
String	getCategory()	A category that allows to group similar services.
org.eclipse.rdf4j.model.IRI	getConsumes()	The artifact type consumed.
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.
AreaTreeOperator	getOperator()
Object	getParam(String name)	Obtains the parameter using the appropriate getter method (if present).
org.eclipse.rdf4j.model.IRI	getProduces()	The artifact type produced.
Artifact	process(Artifact input)	Consumes an input artifact and produces an output artifact.
boolean	setParam(String name, Object value)	Sets the parameter using the appropriate setter method (if present).

Methods inherited from class cz.vutbr.fit.layout.impl.BaseArtifactService

toString

Methods inherited from class cz.vutbr.fit.layout.impl.BaseParametrizedOperation

getParams, getParamString

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

setServiceManager

Constructor Detail

OperatorWrapperProvider

public OperatorWrapperProvider(AreaTreeOperator operator)

Method Detail

getOperator

public AreaTreeOperator getOperator()

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.

Specified by:

getCategory in interface Service

Overrides:

getCategory in class BaseArtifactService

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.

setParam

public boolean setParam(String name,
                        Object value)

Description copied from class: BaseParametrizedOperation

Sets the parameter using the appropriate setter method (if present).

Specified by:

setParam in interface ParametrizedOperation

Overrides:

setParam in class BaseParametrizedOperation

Parameters:

name - parameter name

value - parameter value

Returns:

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

getParam

public Object getParam(String name)

Description copied from class: BaseParametrizedOperation

Obtains the parameter using the appropriate getter method (if present).

Specified by:

getParam in interface ParametrizedOperation

Overrides:

getParam in class BaseParametrizedOperation

Parameters:

name - the parameter name

Returns:

the parameter value or null for unknown parameter

getConsumes

public org.eclipse.rdf4j.model.IRI getConsumes()

Description copied from interface: ArtifactService

The artifact type consumed.

Returns:

the artifact type IRI or null when nothing is consumed (source only).

getProduces

public org.eclipse.rdf4j.model.IRI getProduces()

Description copied from interface: ArtifactService

The artifact type produced.

Returns:

the artifact type IRI or null when nothing is produced (consumer only).

process

public Artifact process(Artifact input)
                 throws ServiceException

Description copied from interface: ArtifactService

Consumes an input artifact and produces an output artifact.

Parameters:

input - The input artifact or null when nothing is consumed

Returns:

the output artifact null when nothing is produced

Throws:

ServiceException