gate

Interface Resource

All Superinterfaces:

FeatureBearer, NameBearer, Serializable

All Known Subinterfaces:

AnnotationList, AnnotationVisualResource, ConditionalController, Controller, ControllerAwarePR, Corpus, CorpusController, Document, DocumentView, IndexedCorpus, LanguageAnalyser, LanguageResource, Ontology, OwnedAnnotationEditor, ProcessingResource, ResizableVisualResource, SimpleCorpus, SimpleDocument, TextualDocument, VisualResource, WordNet

All Known Implementing Classes:

AbstractController, AbstractDocumentView, AbstractLanguageAnalyser, AbstractLanguageResource, AbstractProcessingResource, AbstractResource, AbstractVisualResource, AnnotationEditor, AnnotationListView, AnnotationSchema, AnnotationSetsView, AnnotationStackView, ConditionalSerialAnalyserController, ConditionalSerialController, ConllDocumentFormat, ControllerMetadataViewer, CorefEditor, CorpusAnnotationDiff, CorpusEditor, CorpusExporter, CorpusImpl, CorpusQualityAssurance, DocumentEditor, DocumentExporter, DocumentFormat, DocumentImpl, EmailDocumentFormat, FeaturesSchemaEditor, GateXMLExporter, InlineXMLExporter, LuceneDataStoreSearchGUI, NekoHtmlDocumentFormat, PackagedController, PRViewer, RealtimeCorpusController, RelationSetView, ResourceHelper, SerialAnalyserController, SerialController, SerialControllerEditor, SerialCorpusImpl, SerialDatastoreViewer, SgmlDocumentFormat, TextualDocumentFormat, TextualDocumentView, TikaFormat, UimaDocumentFormat, XmlDocumentFormat

public interface Resource
extends FeatureBearer, NameBearer, Serializable

Models all sorts of resources.

Method Summary

Modifier and Type	Method and Description
void	cleanup() Clears the internal data of the resource, when it gets released
Object	getParameterValue(String paramaterName) Gets the value of a parameter of this resource.
Resource	init() Initialise this resource, and return it.
void	setParameterValue(String paramaterName, Object parameterValue) Sets the value for a specified parameter.
void	setParameterValues(FeatureMap parameters) Sets the values for more parameters in one step.

Methods inherited from interface gate.util.FeatureBearer

getFeatures, setFeatures

Methods inherited from interface gate.util.NameBearer

getName, setName

Method Detail

init

Resource init()
       throws ResourceInstantiationException

Initialise this resource, and return it.

Throws:

ResourceInstantiationException

cleanup

void cleanup()

Clears the internal data of the resource, when it gets released

getParameterValue

Object getParameterValue(String paramaterName)
                  throws ResourceInstantiationException

Gets the value of a parameter of this resource.

Parameters:

paramaterName - the name of the parameter

Returns:

the current value of the parameter

Throws:

ResourceInstantiationException

setParameterValue

void setParameterValue(String paramaterName,
                       Object parameterValue)
                throws ResourceInstantiationException

Sets the value for a specified parameter.

Parameters:

paramaterName - the name for the parameteer

parameterValue - the value the parameter will receive

Throws:

ResourceInstantiationException

setParameterValues

void setParameterValues(FeatureMap parameters)
                 throws ResourceInstantiationException

Sets the values for more parameters in one step.

Parameters:

parameters - a FeatureMap that has parameter names as keys and parameter values as values.

Throws:

ResourceInstantiationException