PresentationBasedChunksSource (FitLayout 2.0.3 API)

java.lang.Object
- cz.vutbr.fit.layout.text.chunks.ChunksSource
- - cz.vutbr.fit.layout.text.chunks.PresentationBasedChunksSource

```
public class PresentationBasedChunksSource
extends ChunksSource
```
A chunk source that follows some presentation patterns in order to improve the chunk extraction. Chunk extraction goes through the tree of areas. For every leaf area of the tree, the chunk extraction consists of the following phases:
1. Box extraction - extraction of a source boxes from the given source areas. We obtain a list of boxes that are later used as the source text for extracting the text chunks.
2. Occurence extraction - location of the tag occurences in the source box text. We obtain a list of occurences.
3. Chunk creation - creation of the chunks from the occurences. We obtain a list of chunks found in the box text.
Finally, the chunks obtained from the individual areas are joined to a single list. The individual phases of the extraction may be influenced by different presentation hints registered using the addHint(Tag, PresentationHint) method.
Author:

burgetr

Constructor Summary

Constructors
Constructor	Description
`PresentationBasedChunksSource(Area root, TaggerConfig tagConfig, float minTagSupport, ChunksCache cache)`	Creates a new source.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addHint(Tag tag, PresentationHint hint)`
`List<TextChunk>`	`getTextChunks()`	Extracts a list of chunks from the source area tree.
`String`	`toString()`

Methods inherited from class cz.vutbr.fit.layout.text.chunks.ChunksSource
getRoot

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PresentationBasedChunksSource
```
public PresentationBasedChunksSource(Area root,
                                     TaggerConfig tagConfig,
                                     float minTagSupport,
                                     ChunksCache cache)
```
    Creates a new source.
    
    Parameters:
    
    root - the root area of the area tree
    
    minTagSupport - minimal support of the tags for considering the areas for chunk extraction
    
    cache - the cache of already extracted chunks for sharing the chunks among different sources or null when no cache should be used.
- Method Detail
  - getTextChunks
```
public List<TextChunk> getTextChunks()
```
    Description copied from class: ChunksSource
    
    Extracts a list of chunks from the source area tree.
    
    Specified by:
    
    getTextChunks in class ChunksSource
    
    Returns:
  - addHint
```
public void addHint(Tag tag,
                    PresentationHint hint)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object