com.ontotext.gate.gazetteer
Class HashGazetteer

java.lang.Object
  extended by gate.util.AbstractFeatureBearer
      extended by gate.creole.AbstractResource
          extended by gate.creole.AbstractProcessingResource
              extended by gate.creole.AbstractLanguageAnalyser
                  extended by gate.creole.gazetteer.AbstractGazetteer
                      extended by com.ontotext.gate.gazetteer.HashGazetteer
All Implemented Interfaces:
ANNIEConstants, Gazetteer, Executable, LanguageAnalyser, ProcessingResource, Resource, FeatureBearer, NameBearer, Serializable

public class HashGazetteer
extends AbstractGazetteer

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class gate.creole.AbstractProcessingResource
AbstractProcessingResource.InternalStatusListener, AbstractProcessingResource.IntervalProgressListener
 
Field Summary
private  AnnotationSet annotationSet
           
private  ArrayList<Lookup> categoryList
           
private  Map<LinearNode,GazetteerList> listsByNode
           
private  Map<String,List<Lookup>>[] mapsList
           
private  int mapsListSize
           
private static long serialVersionUID
           
 
Fields inherited from class gate.creole.gazetteer.AbstractGazetteer
annotationSetName, caseSensitive, definition, encoding, features, listeners, listsURL, longestMatchOnly, mappingDefinition, wholeWordsOnly
 
Fields inherited from class gate.creole.AbstractLanguageAnalyser
corpus, document
 
Fields inherited from class gate.creole.AbstractProcessingResource
interrupted
 
Fields inherited from class gate.creole.AbstractResource
name
 
Fields inherited from interface gate.creole.ANNIEConstants
ANNOTATION_COREF_FEATURE_NAME, DATE_ANNOTATION_TYPE, DATE_POSTED_ANNOTATION_TYPE, DEFAULT_FILE, DOCUMENT_COREF_FEATURE_NAME, JOB_ID_ANNOTATION_TYPE, LOCATION_ANNOTATION_TYPE, LOOKUP_ANNOTATION_TYPE, LOOKUP_CLASS_FEATURE_NAME, LOOKUP_INSTANCE_FEATURE_NAME, LOOKUP_LANGUAGE_FEATURE_NAME, LOOKUP_MAJOR_TYPE_FEATURE_NAME, LOOKUP_MINOR_TYPE_FEATURE_NAME, LOOKUP_ONTOLOGY_FEATURE_NAME, MONEY_ANNOTATION_TYPE, ORGANIZATION_ANNOTATION_TYPE, PERSON_ANNOTATION_TYPE, PERSON_GENDER_FEATURE_NAME, PLUGIN_DIR, PR_NAMES, SENTENCE_ANNOTATION_TYPE, SPACE_TOKEN_ANNOTATION_TYPE, TOKEN_ANNOTATION_TYPE, TOKEN_CATEGORY_FEATURE_NAME, TOKEN_KIND_FEATURE_NAME, TOKEN_LENGTH_FEATURE_NAME, TOKEN_ORTH_FEATURE_NAME, TOKEN_STRING_FEATURE_NAME
 
Constructor Summary
HashGazetteer()
           
 
Method Summary
private  String a(String s, boolean flag)
           
 boolean add(String s, Lookup lookup1)
          Adds a new string to the gazetteer
private  boolean annotate(String s, int i, int j, int k)
           
 void execute()
          Run the resource.
 Resource init()
          Initialise this resource, and return it.
 Set<Lookup> lookup(String s)
          Looks-up a string
private  String normalizeWhitespace(String s)
          Normalizes the whitespace within the String instance by replacing any sequence of one or more whitespace characters with a single space.
private  void readList(LinearNode linearnode)
           
 boolean remove(String s)
          Removes a string from the gazetteer
private  String removeTrailingSymbols(String s)
          Works backwards through the String parameter removing each character until it encounters a letter, digit, or whitespace at which point it returns the truncated string.
 
Methods inherited from class gate.creole.gazetteer.AbstractGazetteer
addGazetteerListener, fireGazetteerEvent, getAnnotationSetName, getCaseSensitive, getEncoding, getFeatures, getLinearDefinition, getListsURL, getLongestMatchOnly, getMappingDefinition, getWholeWordsOnly, reInit, setAnnotationSetName, setCaseSensitive, setEncoding, setFeatures, setListsURL, setLongestMatchOnly, setMappingDefinition, setWholeWordsOnly
 
Methods inherited from class gate.creole.AbstractLanguageAnalyser
getCorpus, getDocument, setCorpus, setDocument
 
Methods inherited from class gate.creole.AbstractProcessingResource
addProgressListener, addStatusListener, cleanup, fireProcessFinished, fireProgressChanged, fireStatusChanged, interrupt, isInterrupted, removeProgressListener, removeStatusListener
 
Methods inherited from class gate.creole.AbstractResource
checkParameterValues, getBeanInfo, getName, getParameterValue, getParameterValue, removeResourceListeners, setName, setParameterValue, setParameterValue, setParameterValues, setParameterValues, setResourceListeners
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface gate.LanguageAnalyser
getCorpus, getDocument, setCorpus, setDocument
 
Methods inherited from interface gate.Resource
cleanup, getParameterValue, setParameterValue, setParameterValues
 
Methods inherited from interface gate.util.NameBearer
getName, setName
 
Methods inherited from interface gate.Executable
interrupt, isInterrupted
 

Field Detail

serialVersionUID

private static final long serialVersionUID
See Also:
Constant Field Values

categoryList

private ArrayList<Lookup> categoryList

listsByNode

private Map<LinearNode,GazetteerList> listsByNode

mapsList

private Map<String,List<Lookup>>[] mapsList

mapsListSize

private int mapsListSize

annotationSet

private AnnotationSet annotationSet
Constructor Detail

HashGazetteer

public HashGazetteer()
Method Detail

init

public Resource init()
              throws ResourceInstantiationException
Description copied from class: AbstractProcessingResource
Initialise this resource, and return it.

Specified by:
init in interface Resource
Overrides:
init in class AbstractProcessingResource
Throws:
ResourceInstantiationException

execute

public void execute()
             throws ExecutionException
Description copied from class: AbstractProcessingResource
Run the resource. It doesn't make sense not to override this in subclasses so the default implementation signals an exception.

Specified by:
execute in interface Executable
Overrides:
execute in class AbstractProcessingResource
Throws:
ExecutionException

add

public boolean add(String s,
                   Lookup lookup1)
Description copied from interface: Gazetteer
Adds a new string to the gazetteer

lookup1 - the lookup to be associated with the new string
Returns:
true if the operation was successful

lookup

public Set<Lookup> lookup(String s)
Description copied from interface: Gazetteer
Looks-up a string

Parameters:
s - the string
Returns:
set of Lookups

annotate

private boolean annotate(String s,
                         int i,
                         int j,
                         int k)

remove

public boolean remove(String s)
Removes a string from the gazetteer

Parameters:
s - the item to remove
Returns:
true if the operation was successful

removeTrailingSymbols

private String removeTrailingSymbols(String s)
Works backwards through the String parameter removing each character until it encounters a letter, digit, or whitespace at which point it returns the truncated string.

Parameters:
s - the String you wish to remove trailing symbols from
Returns:
the truncated String that now ends in a letter, digit, or whitespace character

normalizeWhitespace

private String normalizeWhitespace(String s)
Normalizes the whitespace within the String instance by replacing any sequence of one or more whitespace characters with a single space. Not that any leading/trailing whitespace is also removed.

Parameters:
s - the String to normalize
Returns:
the normalized String

a

private String a(String s,
                 boolean flag)

readList

private void readList(LinearNode linearnode)
               throws GazetteerException
Throws:
GazetteerException