gate.creole.gazetteer

Class GazetteerList

java.lang.Object

gate.util.AbstractFeatureBearer

gate.creole.AbstractResource

gate.creole.AbstractLanguageResource

gate.creole.gazetteer.GazetteerList

All Implemented Interfaces:

LanguageResource, Resource, FeatureBearer, NameBearer, Serializable, Iterable<GazetteerNode>, Collection<GazetteerNode>, List<GazetteerNode>

public class GazetteerList
extends AbstractLanguageResource
implements List<GazetteerNode>

Gazetteer List provides the means for uploading, managing and storing the data in the gazetteer list files.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	LIST_MODE indicates list representation of the gazetteer list
static int	STRING_MODE indicates representation of the gaz list as a single string

Fields inherited from class gate.creole.AbstractLanguageResource

dataStore, lrPersistentId

Fields inherited from class gate.creole.AbstractResource

name

Fields inherited from class gate.util.AbstractFeatureBearer

features

Constructor Summary

Constructors

Constructor and Description
GazetteerList() create a new gazetteer list

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(GazetteerNode o)
void	add(int index, GazetteerNode element)
boolean	addAll(Collection<? extends GazetteerNode> c) Adds entire collection
boolean	addAll(int index, Collection<? extends GazetteerNode> c)
void	clear()
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
boolean	equals(Object obj)
GazetteerNode	get(int index)
String	getEncoding() Gets the encoding of the list
int	getMode() Retrieves the current mode of the gaz list
String	getSeparator()
URL	getURL() Gets the URL of the list
int	hashCode()
int	indexOf(Object o)
boolean	isEmpty()
boolean	isModified() Returns true of an LR has been modified since the last sync.
Iterator<GazetteerNode>	iterator() Gets an iterator over the list.
int	lastIndexOf(Object o)
ListIterator<GazetteerNode>	listIterator()
ListIterator<GazetteerNode>	listIterator(int index)
void	load() Loads a gazetteer list
void	load(boolean isOrdered) Loads a gazetteer list
GazetteerNode	remove(int index)
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
boolean	retainAll(Collection<?> c)
GazetteerNode	set(int index, GazetteerNode element)
void	setEncoding(String encod) Sets the encoding of the list
void	setMode(int m) Sets mode of the gazetteer list
void	setModified(boolean modified) Sets the modified status of the current list
void	setSeparator(String separator)
void	setURL(URL theUrl) Sets the URL of the list
int	size()
void	store() Stores the list to the specified url
List<GazetteerNode>	subList(int fromIndex, int toIndex)
Object[]	toArray()
<T> T[]	toArray(T[] a)
String	toString() Retrieves the string representation of the gaz list according to its mode.
void	updateContent(String newContent) Updates the content of the gaz list with the given parameter.

Methods inherited from class gate.creole.AbstractLanguageResource

cleanup, getDataStore, getLRPersistenceId, getParent, setDataStore, setLRPersistenceId, setParent, sync

Methods inherited from class gate.creole.AbstractResource

checkParameterValues, flushBeanInfoCache, forgetBeanInfo, getBeanInfo, getInitParameterValues, getInitParameterValues, getName, getParameterValue, getParameterValue, getParameterValues, init, removeResourceListeners, setName, setParameterValue, setParameterValue, setParameterValues, setParameterValues, setResourceListeners

Methods inherited from class gate.util.AbstractFeatureBearer

getFeatures, setFeatures

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface gate.Resource

getParameterValue, init, setParameterValue, setParameterValues

Methods inherited from interface gate.util.FeatureBearer

getFeatures, setFeatures

Methods inherited from interface gate.util.NameBearer

getName, setName

Field Detail

LIST_MODE

public static final int LIST_MODE

indicates list representation of the gazetteer list

See Also:

Constant Field Values

STRING_MODE

public static final int STRING_MODE

indicates representation of the gaz list as a single string

See Also:

Constant Field Values

Constructor Detail

GazetteerList

public GazetteerList()

create a new gazetteer list

Method Detail

isModified

public boolean isModified()

Description copied from class: AbstractLanguageResource

Returns true of an LR has been modified since the last sync. Always returns false for transient LRs.

Specified by:

isModified in interface LanguageResource

Overrides:

isModified in class AbstractLanguageResource

Returns:

true if the list has been modified after load/store

setModified

public void setModified(boolean modified)

Sets the modified status of the current list

Parameters:

modified - is modified flag

getMode

public int getMode()

Retrieves the current mode of the gaz list

Returns:

the current mode

setMode

public void setMode(int m)

Sets mode of the gazetteer list

Parameters:

m - the mode to be set

setEncoding

public void setEncoding(String encod)

Sets the encoding of the list

Parameters:

encod - the encoding to be set

getEncoding

public String getEncoding()

Gets the encoding of the list

Returns:

the encoding of the list

load

public void load()
          throws ResourceInstantiationException

Loads a gazetteer list

Throws:

ResourceInstantiationException - when the resource cannot be created

load

public void load(boolean isOrdered)
          throws ResourceInstantiationException

Loads a gazetteer list

Parameters:

isOrdered - true if the feature maps used should be ordered

Throws:

ResourceInstantiationException - when the resource cannot be created

store

public void store()
           throws ResourceInstantiationException

Stores the list to the specified url

Throws:

ResourceInstantiationException

setURL

public void setURL(URL theUrl)

Sets the URL of the list

Parameters:

theUrl - the URL of the List

getURL

public URL getURL()

Gets the URL of the list

Returns:

the URL of the list

getSeparator

public String getSeparator()

Returns:

the seperator

setSeparator

public void setSeparator(String separator)

Parameters:

separator - the separator to set

size

public int size()

Specified by:

size in interface Collection<GazetteerNode>

Specified by:

size in interface List<GazetteerNode>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<GazetteerNode>

Specified by:

isEmpty in interface List<GazetteerNode>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<GazetteerNode>

Specified by:

contains in interface List<GazetteerNode>

iterator

public Iterator<GazetteerNode> iterator()

Gets an iterator over the list. It is not dangerous if the iterator is modified since there are no dependencies of entries to other members

Specified by:

iterator in interface Iterable<GazetteerNode>

Specified by:

iterator in interface Collection<GazetteerNode>

Specified by:

iterator in interface List<GazetteerNode>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<GazetteerNode>

Specified by:

toArray in interface List<GazetteerNode>

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface Collection<GazetteerNode>

Specified by:

toArray in interface List<GazetteerNode>

add

public boolean add(GazetteerNode o)

Specified by:

add in interface Collection<GazetteerNode>

Specified by:

add in interface List<GazetteerNode>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<GazetteerNode>

Specified by:

remove in interface List<GazetteerNode>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<GazetteerNode>

Specified by:

containsAll in interface List<GazetteerNode>

addAll

public boolean addAll(Collection<? extends GazetteerNode> c)

Adds entire collection

Specified by:

addAll in interface Collection<GazetteerNode>

Specified by:

addAll in interface List<GazetteerNode>

Parameters:

c - a collection to be addded

Returns:

true if all the elements where Strings and all are sucessfully added

addAll

public boolean addAll(int index,
             Collection<? extends GazetteerNode> c)

Specified by:

addAll in interface List<GazetteerNode>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<GazetteerNode>

Specified by:

removeAll in interface List<GazetteerNode>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<GazetteerNode>

Specified by:

retainAll in interface List<GazetteerNode>

clear

public void clear()

Specified by:

clear in interface Collection<GazetteerNode>

Specified by:

clear in interface List<GazetteerNode>

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<GazetteerNode>

Specified by:

hashCode in interface List<GazetteerNode>

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Specified by:

equals in interface Collection<GazetteerNode>

Specified by:

equals in interface List<GazetteerNode>

Overrides:

equals in class Object

get

public GazetteerNode get(int index)

Specified by:

get in interface List<GazetteerNode>

set

public GazetteerNode set(int index,
                GazetteerNode element)

Specified by:

set in interface List<GazetteerNode>

add

public void add(int index,
       GazetteerNode element)

Specified by:

add in interface List<GazetteerNode>

remove

public GazetteerNode remove(int index)

Specified by:

remove in interface List<GazetteerNode>

indexOf

public int indexOf(Object o)

Specified by:

indexOf in interface List<GazetteerNode>

lastIndexOf

public int lastIndexOf(Object o)

Specified by:

lastIndexOf in interface List<GazetteerNode>

listIterator

public ListIterator<GazetteerNode> listIterator()

Specified by:

listIterator in interface List<GazetteerNode>

listIterator

public ListIterator<GazetteerNode> listIterator(int index)

Specified by:

listIterator in interface List<GazetteerNode>

subList

public List<GazetteerNode> subList(int fromIndex,
                          int toIndex)

Specified by:

subList in interface List<GazetteerNode>

toString

public String toString()

Retrieves the string representation of the gaz list according to its mode. If LIST_MODE then all the entries are dumped sequentially to a string. If STRING_MODE then the content (a string) of the gaz list is retrieved.

Overrides:

toString in class AbstractResource

Returns:

the string representation of the gaz list

updateContent

public void updateContent(String newContent)

Updates the content of the gaz list with the given parameter. Depends on the mode of the gaz list. In the case of LIST_MODE the new content is parsed and loaded as single nodes through the List interface. In the case of STRING_MODE the new content is stored as a String and is not parsed.

Parameters:

newContent - the new content of the gazetteer list