public class FsVariablesImpl extends Object implements FsVariables
INDEX_NAME, NAME_FEATURE_NAME, TYPE_FEATURE_NAME, TYPE_NAME, VALUE_FEATURE_NAME
Constructor and Description |
---|
FsVariablesImpl() |
Modifier and Type | Method and Description |
---|---|
boolean |
checkCas(org.apache.uima.cas.CAS cas)
Check a CAS for FsVariable type system and index definition.
|
void |
declareFsVariable(String name,
org.apache.uima.cas.Type type)
Declare a new FsVariable.
|
org.apache.uima.cas.Type |
getFsVariableType(String name)
Get the type of an FsVariable.
|
org.apache.uima.cas.FeatureStructure |
getVariableValue(String name)
Get the FeatureStructure value of a variable.
|
void |
init(org.apache.uima.cas.CAS cas)
Initialize
this with current CAS. |
boolean |
isFsVariable(String name)
Check if a variable of that name exists.
|
List |
listFsVariables()
Return a list of all variable names that are currently declared.
|
List |
listFsVariables(org.apache.uima.cas.Type type)
Return a list of all variable names of those variables whose type is a subtype of the type
parameter.
|
void |
setVariable(String name,
org.apache.uima.cas.FeatureStructure fs)
Set the value of an existing variable.
|
public void declareFsVariable(String name, org.apache.uima.cas.Type type)
FsVariables
isFsVariable(String)
to check if a variable with the same name
already exists.declareFsVariable
in interface FsVariables
name
- The name of the variable.type
- The type of the variable.public org.apache.uima.cas.Type getFsVariableType(String name)
FsVariables
getFsVariableType
in interface FsVariables
name
- The name of the variable.public org.apache.uima.cas.FeatureStructure getVariableValue(String name)
FsVariables
getVariableValue
in interface FsVariables
name
- The name of the variable.public boolean isFsVariable(String name)
FsVariables
isFsVariable
in interface FsVariables
name
- The name of the variable.true
iff a FsVariable of that name exists.public List listFsVariables()
FsVariables
listFsVariables
in interface FsVariables
public List listFsVariables(org.apache.uima.cas.Type type)
FsVariables
listFsVariables
in interface FsVariables
type
- The type of variables we want to see.public void setVariable(String name, org.apache.uima.cas.FeatureStructure fs)
FsVariables
setVariable
in interface FsVariables
name
- The name of the variable.fs
- The value to set.public void init(org.apache.uima.cas.CAS cas)
FsVariables
this
with current CAS. This needs to be called on every process, before
any other APIs are called!init
in interface FsVariables
cas
- The current CAS.public boolean checkCas(org.apache.uima.cas.CAS cas)
FsVariables
true
,
init(CAS)
will not throw an exception.checkCas
in interface FsVariables
cas
- The CAS to check.true
iff CAS contains required type and index.Copyright © 2006–2024 The Apache Software Foundation. All rights reserved.