gate
Interface LanguageResource

All Superinterfaces:

FeatureBearer, NameBearer, Resource, Serializable

All Known Subinterfaces:

Corpus, Document, IndexedCorpus, LexicalKnowledgeBase, Lexicon, MutableLexicalKnowledgeBase, NLGLexicon, OntoLexLR, Ontology, ProtegeProject, SimpleCorpus, SimpleDocument, Taxonomy, TextualDocument, WordNet

All Known Implementing Classes:

AbstractLanguageResource, AnnotationSchema, CorpusImpl, DatabaseCorpusImpl, DatabaseDocumentImpl, DocumentFormat, DocumentImpl, EmailDocumentFormat, GazetteerList, HtmlDocumentFormat, IndexFileWordNetImpl, JenaOntologyImpl, LinearDefinition, MappingDefinition, MSWordDocumentFormat, MutableLexicalKnowledgeBaseImpl, NLGLexiconImpl, OntoLexKBImpl, OntologyImpl, PdfDocumentFormat, ProtegeProjectName, RtfDocumentFormat, SerialCorpusImpl, SgmlDocumentFormat, TaxonomyImpl, TextualDocumentFormat, XmlDocumentFormat

public interface LanguageResource
extends Resource

Models all sorts of language resources.

Method Summary

DataStore	getDataStore() Get the data store that this LR lives in.
Object	getLRPersistenceId() Returns the persistence id of this LR, if it has been stored in a datastore.
LanguageResource	getParent() Returns the parent LR of this LR.
boolean	isModified() Returns true of an LR has been modified since the last sync.
void	setDataStore(DataStore dataStore) Set the data store that this LR lives in.
void	setLRPersistenceId(Object lrID) Sets the persistence id of this LR.
void	setParent(LanguageResource parentLR) Sets the parent LR of this LR.
void	sync() Save: synchonise the in-memory image of the LR with the persistent image.

Methods inherited from interface gate.Resource

cleanup, getParameterValue, init, setParameterValue, setParameterValues

Methods inherited from interface gate.util.FeatureBearer

getFeatures, setFeatures

Methods inherited from interface gate.util.NameBearer

getName, setName

Method Detail

getDataStore

DataStore getDataStore()

Get the data store that this LR lives in. Null for transient LRs.

setDataStore

void setDataStore(DataStore dataStore)
                  throws PersistenceException

Set the data store that this LR lives in.

Throws:

PersistenceException

getLRPersistenceId

Object getLRPersistenceId()

Returns the persistence id of this LR, if it has been stored in a datastore. Null otherwise.

setLRPersistenceId

void setLRPersistenceId(Object lrID)

Sets the persistence id of this LR. To be used only in the Factory and DataStore code.

sync

void sync()
          throws PersistenceException,
                 SecurityException

Save: synchonise the in-memory image of the LR with the persistent image.

Throws:

PersistenceException

SecurityException

isModified

boolean isModified()

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

getParent

LanguageResource getParent()
                           throws PersistenceException,
                                  SecurityException

Returns the parent LR of this LR. Only relevant for LRs that support shadowing. Most do not by default.

Throws:

PersistenceException

SecurityException

setParent

void setParent(LanguageResource parentLR)
               throws PersistenceException,
                      SecurityException

Sets the parent LR of this LR. Only relevant for LRs that support shadowing. Most do not by default.

Throws:

PersistenceException

SecurityException