Ace2005GoldReader (ClearTK TimeML 2.0.0 API)

java.lang.Object
- org.apache.uima.resource.Resource_ImplBase
- - org.apache.uima.resource.ConfigurableResource_ImplBase
  - - org.apache.uima.collection.CollectionReader_ImplBase
    - - org.apache.uima.fit.component.JCasCollectionReader_ImplBase
      - org.cleartk.corpus.ace2005.Ace2005GoldReader

All Implemented Interfaces:

BaseCollectionReader, CollectionReader, ConfigurableResource, Resource
```
public class Ace2005GoldReader
extends org.apache.uima.fit.component.JCasCollectionReader_ImplBase
```
Copyright (c) 2007-2008, Regents of the University of Colorado
All rights reserved.

Author:

Philip Ogren

Field Summary

Fields
Modifier and Type Field and Description

static String PARAM_ACE_DIRECTORY_NAME

static String PARAM_ACE_FILE_NAMES_FILE

static String TAG_REGEX
- Fields inherited from interface org.apache.uima.resource.Resource
  PARAM_AGGREGATE_SOFA_MAPPINGS, PARAM_CONFIG_MANAGER, PARAM_CONFIG_PARAM_SETTINGS, PARAM_EXTERNAL_OVERRIDE_SETTINGS, PARAM_PERFORMANCE_TUNING_SETTINGS, PARAM_RESOURCE_MANAGER, PARAM_UIMA_CONTEXT

Fields
Modifier and Type	Field and Description
`static String`	`PARAM_ACE_DIRECTORY_NAME`
`static String`	`PARAM_ACE_FILE_NAMES_FILE`
`static String`	`TAG_REGEX`

Constructor Summary

Constructors
Constructor and Description

Ace2005GoldReader()

Constructors
Constructor and Description
`Ace2005GoldReader()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()`
`void`	`getNext(JCas jCas)`
`Progress[]`	`getProgress()` Progress is measured by the number of files in the target directory - not by the number of times getNext has been (and will be) called.
`boolean`	`hasNext()`
`void`	`initialize(UimaContext context)`
`void`	`setAceDirectoryName(String aceDirectoryName)`
`void`	`setAceFileNamesFile(String aceFileNamesFile)`

Methods inherited from class org.apache.uima.fit.component.JCasCollectionReader_ImplBase
getLogger, getNext, initialize

Methods inherited from class org.apache.uima.collection.CollectionReader_ImplBase
destroy, getCasInitializer, getProcessingResourceMetaData, initialize, isConsuming, reconfigure, setCasInitializer, typeSystemInit

Methods inherited from class org.apache.uima.resource.ConfigurableResource_ImplBase
getConfigParameterValue, getConfigParameterValue, setConfigParameterValue, setConfigParameterValue

Methods inherited from class org.apache.uima.resource.Resource_ImplBase
getCasManager, getMetaData, getResourceManager, getUimaContext, getUimaContextAdmin, setLogger, setMetaData

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

Methods inherited from interface org.apache.uima.resource.ConfigurableResource
getConfigParameterValue, getConfigParameterValue, setConfigParameterValue, setConfigParameterValue

Methods inherited from interface org.apache.uima.resource.Resource
getMetaData, getResourceManager, getUimaContext, getUimaContextAdmin, setLogger

- Field Detail
  - PARAM_ACE_DIRECTORY_NAME
```
public static final String PARAM_ACE_DIRECTORY_NAME
```
    See Also:
    Constant Field Values
  - PARAM_ACE_FILE_NAMES_FILE
```
public static final String PARAM_ACE_FILE_NAMES_FILE
```
    See Also:
    Constant Field Values
  - TAG_REGEX
```
public static final String TAG_REGEX
```
    See Also:
    Constant Field Values
- Constructor Detail
  - Ace2005GoldReader
```
public Ace2005GoldReader()
```
- Method Detail
  - close
```
public void close()
           throws IOException
```
    Specified by:
    
    close in interface BaseCollectionReader
    
    Overrides:
    
    close in class org.apache.uima.fit.component.JCasCollectionReader_ImplBase
    
    Throws:
    
    IOException
  - getNext
```
public void getNext(JCas jCas)
             throws IOException,
                    CollectionException
```
    Specified by:
    
    getNext in class org.apache.uima.fit.component.JCasCollectionReader_ImplBase
    
    Throws:
    
    IOException
    
    CollectionException
  - getProgress
```
public Progress[] getProgress()
```
    Progress is measured by the number of files in the target directory - not by the number of times getNext has been (and will be) called. This means that the total number of entities to completion is typically going to be 2 or 4 times as many 'documents' that are found depending on what kinds of files exist in the target directory (e.g. *.ag.xml, *.apf.xml, *.sgm, *.tab)
  - hasNext
```
public boolean hasNext()
                throws IOException,
                       CollectionException
```
    Throws:
    
    IOException
    
    CollectionException
  - initialize
```
public void initialize(UimaContext context)
                throws ResourceInitializationException
```
    Overrides:
    
    initialize in class org.apache.uima.fit.component.JCasCollectionReader_ImplBase
    
    Throws:
    
    ResourceInitializationException
  - setAceDirectoryName
```
public void setAceDirectoryName(String aceDirectoryName)
```
  - setAceFileNamesFile
```
public void setAceFileNamesFile(String aceFileNamesFile)
```

Class Ace2005GoldReader

Field Summary

Fields inherited from interface org.apache.uima.resource.Resource

Constructor Summary

Method Summary

Methods inherited from class org.apache.uima.fit.component.JCasCollectionReader_ImplBase

Methods inherited from class org.apache.uima.collection.CollectionReader_ImplBase

Methods inherited from class org.apache.uima.resource.ConfigurableResource_ImplBase

Methods inherited from class org.apache.uima.resource.Resource_ImplBase

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.uima.resource.ConfigurableResource

Methods inherited from interface org.apache.uima.resource.Resource

Field Detail

PARAM_ACE_DIRECTORY_NAME

PARAM_ACE_FILE_NAMES_FILE

TAG_REGEX

Constructor Detail

Ace2005GoldReader

Method Detail

close

getNext

getProgress

hasNext

initialize

setAceDirectoryName

setAceFileNamesFile