JetTest (JET: Java Extractiop Toolkit 1.9.0 API)

java.lang.Object
- edu.nyu.jet.JetTest

```
public class JetTest
extends Object
```
contains the main method for Jet, and the methods for initial loading of linguistic data (grammars, lexicons, patterns, etc.).

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`batchFlag` true to run in 'batch' mode, with no console display window
`static ConceptHierarchy`	`conceptHierarchy`
`static File`	`conceptHierarchyFile`
`protected static Properties`	`config`
`protected static String`	`dataPath`
`protected static Properties`	`defaultConfig`
`static String`	`docId`
`static String`	`encoding`
`static NameAnnotator`	`extendedNameTagger`
`protected static Grammar`	`gram`
`static NameTagger`	`nameTagger`
`static File`	`patternFile`
`static PatternCollection`	`pc`
`static HMMTagger`	`tagger`
`static Set<String>`	`validProperties` the set of valid properties in a Jet properties file; strings ending in "*" indicate that any property name with the specified prefix is valid.
`protected static Vector`	`views`

Constructor Summary

Constructors
Constructor and Description

JetTest()

Constructors
Constructor and Description
`JetTest()`

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`closeAllViews()`
`static String`	`getConfig(String property)` return property 'property' from the configuration file.
`static String`	`getConfigFile(String property)` return file name 'property' from the configuration file; if the value is an absolute path or one beginning "./", return the value of the property; if it is a relative path, prefix it with the value of 'Jet.dataPath' from the configuration file.
`static NumberAnnotator`	`getNumberAnnotator()` Returns instance of `Jet.Time.NumberAnnotator` for annotating number expression.
`static org.joda.time.DateTime`	`getReferenceTime()` Returns reference time for annotating TIMEX.
`static org.joda.time.format.DateTimeFormatter`	`getReferenceTimeFormat()` Returns format of reference time.
`static TimeAnnotator`	`getTimeAnnotator()` Returns instance of `Jet.Time.TimeAnnotator` for annotating TIMEX.
`static void`	`initialize()` load all resources (lexicon, HMMs, patterns, grammar, concepts) as specified in the .properties file.
`static void`	`initializeFromConfig(File configFile)`
`static void`	`initializeFromConfig(File configFile, String jetHome)` read Jet parameter file from file `configFile` and load all specified resources.
`static void`	`initializeFromConfig(String configFile)`
`static void`	`initializeFromConfig(String configFile, String jetHome)`
`static void`	`initTimex()` Initialize parameters for annotating TIMEX.
`static void`	`main(String[] args)`
`static void`	`processFile(String inputFileName, boolean viewable)` process all the documents on file `inputFileName`, displaying the results in View windows if `viewable` is true.
`static void`	`processFiles(boolean viewable)` for each Jet parameter beginning `JetTest.fileName`, invoke `processFile` on that file of documents.
`static void`	`readChunkModel()` if the parameter `Chunker.fileName` is set, load a chunk model from that file.
`static void`	`readConcepts()` if the parameter `Concepts.fileName` is set, load a concept hierarchy from that file.
`static Document`	`readDocument(BufferedReader rdr)` read a document from `rdr`.
`static void`	`readENEData()`
`static void`	`readGazetteer()` if the parameter `Gazetteer.fileName` is set, load a gazetteer.
`static void`	`readGrammar()` if the parameter `Grammar.fileName` is set, load a grammar from that file.
`static void`	`readLexicons()` load all lexicons specified by parameters beginning with the string `EnglishLex.fileName`
`static void`	`readNameTags()` if the parameter `NameTags.fileName` is set, load a name tagger HMM from that file.
`static void`	`readPatterns()` load all pattern files specified by parameters beginning with the string `Pattern.fileName` and set the pattern trace switch if the `Pattern.trace` switch is set.
`static void`	`readTags()` if the parameter `Tags.fileName` is set, load a part-of-speech HMM from that file.
`static boolean`	`setEncoding(String charset)` set the character set used for reading external documents.
`static void`	`setReferenceTime(org.joda.time.DateTime reference)` Sets reference time for annotating TIMEX.

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

- Field Detail
  - validProperties
```
public static Set<String> validProperties
```
    the set of valid properties in a Jet properties file; strings ending in "*" indicate that any property name with the specified prefix is valid.
  - batchFlag
```
public static boolean batchFlag
```
    true to run in 'batch' mode, with no console display window
  - defaultConfig
```
protected static Properties defaultConfig
```
  - config
```
protected static Properties config
```
  - dataPath
```
protected static String dataPath
```
  - pc
```
public static PatternCollection pc
```
  - patternFile
```
public static File patternFile
```
  - gram
```
protected static Grammar gram
```
  - tagger
```
public static HMMTagger tagger
```
  - nameTagger
```
public static NameTagger nameTagger
```
  - views
```
protected static Vector views
```
  - conceptHierarchy
```
public static ConceptHierarchy conceptHierarchy
```
  - conceptHierarchyFile
```
public static File conceptHierarchyFile
```
  - encoding
```
public static String encoding
```
  - docId
```
public static String docId
```
  - extendedNameTagger
```
public static NameAnnotator extendedNameTagger
```
- Constructor Detail
  - JetTest
```
public JetTest()
```
- Method Detail
  - initializeFromConfig
```
public static void initializeFromConfig(File configFile,
                        String jetHome)
```
    read Jet parameter file from file configFile and load all specified resources.
  - initializeFromConfig
```
public static void initializeFromConfig(String configFile,
                        String jetHome)
```
  - initializeFromConfig
```
public static void initializeFromConfig(File configFile)
```
  - initializeFromConfig
```
public static void initializeFromConfig(String configFile)
```
  - getConfig
```
public static String getConfig(String property)
```
    return property 'property' from the configuration file.
  - getConfigFile
```
public static String getConfigFile(String property)
```
    return file name 'property' from the configuration file; if the value is an absolute path or one beginning "./", return the value of the property; if it is a relative path, prefix it with the value of 'Jet.dataPath' from the configuration file.
  - initialize
```
public static void initialize()
```
    load all resources (lexicon, HMMs, patterns, grammar, concepts) as specified in the .properties file.
  - readLexicons
```
public static void readLexicons()
```
    load all lexicons specified by parameters beginning with the string EnglishLex.fileName
  - readTags
```
public static void readTags()
```
    if the parameter Tags.fileName is set, load a part-of-speech HMM from that file.
  - readNameTags
```
public static void readNameTags()
```
    if the parameter NameTags.fileName is set, load a name tagger HMM from that file. If parameter NameTags.emitter is set, use the value of that parameter as the name of the emitter class for the HMM, otherwise used WordFeatureHMMemitter as the default.
  - readPatterns
```
public static void readPatterns()
```
    load all pattern files specified by parameters beginning with the string Pattern.fileName and set the pattern trace switch if the Pattern.trace switch is set.
  - readGrammar
```
public static void readGrammar()
```
    if the parameter Grammar.fileName is set, load a grammar from that file.
  - readChunkModel
```
public static void readChunkModel()
```
    if the parameter Chunker.fileName is set, load a chunk model from that file.
  - readConcepts
```
public static void readConcepts()
```
    if the parameter Concepts.fileName is set, load a concept hierarchy from that file.
  - readGazetteer
```
public static void readGazetteer()
```
    if the parameter Gazetteer.fileName is set, load a gazetteer.
  - readENEData
```
public static void readENEData()
```
  - initTimex
```
public static void initTimex()
```
    Initialize parameters for annotating TIMEX.
  - getReferenceTime
```
public static org.joda.time.DateTime getReferenceTime()
```
    Returns reference time for annotating TIMEX.
  - setReferenceTime
```
public static void setReferenceTime(org.joda.time.DateTime reference)
```
    Sets reference time for annotating TIMEX.
  - getReferenceTimeFormat
```
public static org.joda.time.format.DateTimeFormatter getReferenceTimeFormat()
```
    Returns format of reference time.
  - getTimeAnnotator
```
public static TimeAnnotator getTimeAnnotator()
```
    Returns instance of Jet.Time.TimeAnnotator for annotating TIMEX.
  - getNumberAnnotator
```
public static NumberAnnotator getNumberAnnotator()
```
    Returns instance of Jet.Time.NumberAnnotator for annotating number expression.
  - processFile
```
public static void processFile(String inputFileName,
               boolean viewable)
                        throws IOException
```
    process all the documents on file inputFileName, displaying the results in View windows if viewable is true. The file should contain one or more documents, each beginning with a line <DOC> and ending with a line </DOC> .
    
    Throws:
    
    IOException
  - processFiles
```
public static void processFiles(boolean viewable)
```
    for each Jet parameter beginning JetTest.fileName, invoke processFile on that file of documents.
  - closeAllViews
```
public static void closeAllViews()
```
  - readDocument
```
public static Document readDocument(BufferedReader rdr)
                             throws IOException
```
    read a document from rdr. The document begins with a line <DOC> and ends with a line </DOC> .
    
    Returns:
    a Document with no annotations
    
    Throws:
    
    IOException
  - setEncoding
```
public static boolean setEncoding(String charset)
```
    set the character set used for reading external documents. If a valid character set is specified, return true. If the argument is not valid, print a list of the valid character sets and return false.
  - main
```
public static void main(String[] args)
```

Class JetTest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

validProperties

batchFlag

defaultConfig

config

dataPath

pc

patternFile

gram

tagger

nameTagger

views

conceptHierarchy

conceptHierarchyFile

encoding

docId

extendedNameTagger

Constructor Detail

JetTest

Method Detail

initializeFromConfig

initializeFromConfig

initializeFromConfig

initializeFromConfig

getConfig

getConfigFile

initialize

readLexicons

readTags

readNameTags

readPatterns

readGrammar

readChunkModel

readConcepts

readGazetteer

readENEData

initTimex

getReferenceTime

setReferenceTime

getReferenceTimeFormat

getTimeAnnotator

getNumberAnnotator

processFile

processFiles

closeAllViews

readDocument

setEncoding

main