ExtractionResult (Xponents Core API)

java.lang.Object
- org.opensextant.extraction.ExtractionResult

public class ExtractionResult
extends java.lang.Object

Author:: ubaldino

Field Summary

Fields
Modifier and Type	Field	Description
`java.util.Map<java.lang.String,java.lang.Object>`	`attributes`
`protected static Parameters`	`DEFAULT_FILTERS`
`TextInput`	`input`
`java.util.List<TextMatch>`	`matches`
`java.lang.String`	`recordFile`	Original file for record
`java.lang.String`	`recordID`	short ID or name of file
`java.lang.String`	`recordTextFile`	Text version of file used for processing

Constructor Summary

Constructors
Constructor	Description
`ExtractionResult()`
`ExtractionResult(java.lang.String rid)`	Given a record ID, create a container for holding onto all the geocodes for that particular data object.

Method Summary

Modifier and Type	Method	Description
`void`	`addAttribute(java.lang.String f, java.lang.Object v)`	Add some piece of amplifying metadata about the record which may be carried through to output format in some way

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

- Field Detail
  - DEFAULT_FILTERS
```
protected static final Parameters DEFAULT_FILTERS
```
  - input
```
public TextInput input
```
  - attributes
```
public java.util.Map<java.lang.String,java.lang.Object> attributes
```
  - recordFile
```
public java.lang.String recordFile
```
    Original file for record
  - recordID
```
public java.lang.String recordID
```
    short ID or name of file
  - recordTextFile
```
public java.lang.String recordTextFile
```
    Text version of file used for processing
  - matches
```
public java.util.List<TextMatch> matches
```
- Constructor Detail
  - ExtractionResult
```
public ExtractionResult()
```
  - ExtractionResult
```
public ExtractionResult(java.lang.String rid)
```
    Given a record ID, create a container for holding onto all the geocodes for that particular data object.
    
    Parameters:
    
    rid - result ID, optionally null
- Method Detail
  - addAttribute
```
public void addAttribute(java.lang.String f,
                         java.lang.Object v)
```
    Add some piece of amplifying metadata about the record which may be carried through to output format in some way
    
    Parameters:
    
    f - field
    
    v - value