BasicSegmProvider (FitLayout Basic Segmentation 2.0.4 API)

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.segm.BasicSegmProvider

All Implemented Interfaces:

ArtifactService, ParametrizedOperation, Service
```
public class BasicSegmProvider
extends BaseArtifactService
```
An artifact service provider for transforming the box tree to the area tree. It implements a basic algorithm that only selects the visually separated boxes as the areas.

Author:

burgetr

Constructor Summary

Constructors
Constructor Description

BasicSegmProvider()

BasicSegmProvider(boolean presereAuxAreas)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AreaTree`	`createAreaTree(Page page)`
`List<Parameter>`	`defineParams()`
`org.eclipse.rdf4j.model.IRI`	`getConsumes()`
`String`	`getDescription()`
`String`	`getId()`
`String`	`getName()`
`boolean`	`getPreserveAuxAreas()`
`org.eclipse.rdf4j.model.IRI`	`getProduces()`
`Artifact`	`process(Artifact input)`
`void`	`setPreserveAuxAreas(boolean preserveAuxAreas)`

Methods inherited from class cz.vutbr.fit.layout.impl.BaseArtifactService
getCategory, toString

Methods inherited from class cz.vutbr.fit.layout.impl.BaseParametrizedOperation
getParam, getParams, getParamString, setParam

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

BasicSegmProvider
```
public BasicSegmProvider()
```

BasicSegmProvider

public BasicSegmProvider(boolean presereAuxAreas)

Method Detail

getId
```
public String getId()
```

getName
```
public String getName()
```

getDescription
```
public String getDescription()
```

getConsumes

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

getProduces

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

process

public Artifact process(Artifact input)
                 throws ServiceException

Throws:: ServiceException

createAreaTree

public AreaTree createAreaTree(Page page)

defineParams
```
public List<Parameter> defineParams()
```
Overrides:

defineParams in class BaseParametrizedOperation

getPreserveAuxAreas
```
public boolean getPreserveAuxAreas()
```

setPreserveAuxAreas

public void setPreserveAuxAreas(boolean preserveAuxAreas)