public class CASImpl extends AbstractCas_ImplBase implements CAS, CASMgr, LowLevelCAS
Modifier and Type | Field and Description |
---|---|
static int |
DEFAULT_INITIAL_HEAP_SIZE |
static int |
DEFAULT_RESET_HEAP_SIZE |
static String |
DISABLE_PROTECT_INDEXES
Set this JVM property to false for high performance, (no checking);
insure you don't have the report flag (above) turned on - otherwise it will force this to "true".
|
static int |
FALSE |
static boolean |
IS_THROW_EXCEPTION_CORRUPT_INDEX |
static int |
NULL |
static String |
REPORT_FS_UPDATES_CORRUPTS
Define this JVM property to enable checking for invalid updates to features which are used as
keys by any index.
|
static String |
THROW_EXCEPTION_FS_UPDATES_CORRUPTS
The UIMA framework detects (unless disabled, for high performance) updates to indexed FS which update
key values used as keys in indexes.
|
static boolean |
traceFSs |
static int |
TRUE |
DEFAULT_LANGUAGE_NAME, FEATURE_BASE_NAME_BEGIN, FEATURE_BASE_NAME_END, FEATURE_BASE_NAME_HEAD, FEATURE_BASE_NAME_LANGUAGE, FEATURE_BASE_NAME_SOFA, FEATURE_BASE_NAME_SOFAARRAY, FEATURE_BASE_NAME_SOFAID, FEATURE_BASE_NAME_SOFAMIME, FEATURE_BASE_NAME_SOFANUM, FEATURE_BASE_NAME_SOFASTRING, FEATURE_BASE_NAME_SOFAURI, FEATURE_BASE_NAME_TAIL, FEATURE_FULL_NAME_BEGIN, FEATURE_FULL_NAME_END, FEATURE_FULL_NAME_FLOAT_LIST_HEAD, FEATURE_FULL_NAME_FLOAT_LIST_TAIL, FEATURE_FULL_NAME_FS_LIST_HEAD, FEATURE_FULL_NAME_FS_LIST_TAIL, FEATURE_FULL_NAME_INTEGER_LIST_HEAD, FEATURE_FULL_NAME_INTEGER_LIST_TAIL, FEATURE_FULL_NAME_LANGUAGE, FEATURE_FULL_NAME_SOFA, FEATURE_FULL_NAME_SOFAARRAY, FEATURE_FULL_NAME_SOFAID, FEATURE_FULL_NAME_SOFAMIME, FEATURE_FULL_NAME_SOFANUM, FEATURE_FULL_NAME_SOFASTRING, FEATURE_FULL_NAME_SOFAURI, FEATURE_FULL_NAME_STRING_LIST_HEAD, FEATURE_FULL_NAME_STRING_LIST_TAIL, NAME_DEFAULT_SOFA, NAME_DEFAULT_TEXT_SOFA, NAME_SPACE_UIMA_CAS, NAME_SPACE_UIMA_TCAS, SOFA_INDEX_NAME, STD_ANNOTATION_INDEX, TYPE_NAME_ANNOTATION, TYPE_NAME_ANNOTATION_BASE, TYPE_NAME_ARRAY_BASE, TYPE_NAME_BOOLEAN, TYPE_NAME_BOOLEAN_ARRAY, TYPE_NAME_BYTE, TYPE_NAME_BYTE_ARRAY, TYPE_NAME_DOCUMENT_ANNOTATION, TYPE_NAME_DOUBLE, TYPE_NAME_DOUBLE_ARRAY, TYPE_NAME_EMPTY_FLOAT_LIST, TYPE_NAME_EMPTY_FS_LIST, TYPE_NAME_EMPTY_INTEGER_LIST, TYPE_NAME_EMPTY_STRING_LIST, TYPE_NAME_FLOAT, TYPE_NAME_FLOAT_ARRAY, TYPE_NAME_FLOAT_LIST, TYPE_NAME_FS_ARRAY, TYPE_NAME_FS_LIST, TYPE_NAME_INTEGER, TYPE_NAME_INTEGER_ARRAY, TYPE_NAME_INTEGER_LIST, TYPE_NAME_LIST_BASE, TYPE_NAME_LONG, TYPE_NAME_LONG_ARRAY, TYPE_NAME_NON_EMPTY_FLOAT_LIST, TYPE_NAME_NON_EMPTY_FS_LIST, TYPE_NAME_NON_EMPTY_INTEGER_LIST, TYPE_NAME_NON_EMPTY_STRING_LIST, TYPE_NAME_SHORT, TYPE_NAME_SHORT_ARRAY, TYPE_NAME_SOFA, TYPE_NAME_STRING, TYPE_NAME_STRING_ARRAY, TYPE_NAME_STRING_LIST, TYPE_NAME_TOP, UIMA_CAS_PREFIX
NULL_FS_REF, TYPE_CLASS_BOOLEAN, TYPE_CLASS_BOOLEANARRAY, TYPE_CLASS_BYTE, TYPE_CLASS_BYTEARRAY, TYPE_CLASS_DOUBLE, TYPE_CLASS_DOUBLEARRAY, TYPE_CLASS_FLOAT, TYPE_CLASS_FLOATARRAY, TYPE_CLASS_FS, TYPE_CLASS_FSARRAY, TYPE_CLASS_INT, TYPE_CLASS_INTARRAY, TYPE_CLASS_INVALID, TYPE_CLASS_LONG, TYPE_CLASS_LONGARRAY, TYPE_CLASS_SHORT, TYPE_CLASS_SHORTARRAY, TYPE_CLASS_STRING, TYPE_CLASS_STRINGARRAY
Constructor and Description |
---|
CASImpl()
Constructor.
|
CASImpl(CASMgrSerializer ser) |
CASImpl(int initialHeapSize,
boolean useJcasCache) |
CASImpl(TypeSystemImpl typeSystem,
int initialHeapSize,
boolean useJcasCache) |
Modifier and Type | Method and Description |
---|---|
void |
addFsToIndexes(FeatureStructure fs)
Add a feature structure to all appropriate indexes in the repository associated with this CAS
View.
|
void |
addSofa(FeatureStructure sofa,
String sofaName,
String mimeType) |
void |
checkArrayBounds(int fsRef,
int pos) |
void |
checkArrayBounds(int fsRef,
int pos,
int length) |
void |
checkArrayPreconditions(int len) |
void |
checkTypingConditions(Type domType,
Type ranType,
Feature feat)
Check the range is appropriate for this type/feature.
|
boolean |
clearCasState(CasState state) |
void |
commitFS(FeatureStructure fs)
Deprecated.
|
void |
commitTypeSystem() |
boolean |
containsCasState(CasState state) |
AnnotationFS |
createAnnotation(Type type,
int begin,
int end)
Create a new annotation.
|
ArrayFS |
createArrayFS(int length)
Create a new feature structure array.
|
BooleanArrayFS |
createBooleanArrayFS(int length)
Create a new Boolean array.
|
ByteArrayFS |
createByteArrayFS(int length)
Create a new Byte array.
|
DoubleArrayFS |
createDoubleArrayFS(int length)
Create a new Double array.
|
FeaturePath |
createFeaturePath()
Create a feature path.
|
FeatureValuePath |
createFeatureValuePath(String featureValuePath)
Create a feature-value path from a string.
|
<T extends FeatureStructure> |
createFilteredIterator(FSIterator<T> it,
FSMatchConstraint cons)
Create an iterator over structures satisfying a given constraint.
|
FloatArrayFS |
createFloatArrayFS(int length)
Create a new int array.
|
<T extends FeatureStructure> |
createFS(int addr)
This is your link from the low-level API to the high-level API.
|
<T extends FeatureStructure> |
createFS(Type type)
Create a new FeatureStructure.
|
IntArrayFS |
createIntArrayFS(int length)
Create a new int array.
|
LongArrayFS |
createLongArrayFS(int length)
Create a new Long array.
|
Marker |
createMarker()
The current implementation only supports 1 marker call per
CAS.
|
ShortArrayFS |
createShortArrayFS(int length)
Create a new Short array.
|
SofaFS |
createSofa(SofaID sofaID,
String mimeType)
Deprecated.
|
StringArrayFS |
createStringArrayFS(int length)
Create a new String array.
|
int |
createTempArray(int type,
int len)
Create a temporary (i.e., per document) array FS on the heap.
|
CAS |
createView(String aSofaID)
Create a view and its underlying Sofa (subject of analysis).
|
static long |
double2long(double d) |
boolean |
doUseJcasCache() |
void |
enableReset(boolean flag)
Enable/disable resetting the CAS with
CAS.reset() . |
static int |
float2int(float f) |
void |
flush()
Deprecated.
Use
reset() instead. |
<T extends FeatureStructure> |
fs2listIterator(FSIterator<T> it)
Wrap a standard Java
ListIterator around an FSListIterator. |
<T extends AnnotationFS> |
getAnnotationIndex()
The generic spec T extends AnnotationFS (rather than AnnotationFS) allows the method
JCasImpl getAnnotationIndex to return Annotation instead of AnnotationFS
|
<T extends AnnotationFS> |
getAnnotationIndex(Type type)
Get the standard annotation index restricted to a specific annotation type.
|
Type |
getAnnotationType()
Get the type object for the annotation type.
|
int |
getArrayStartAddress(int addr)
Get the heap address of the first cell of this array.
|
int |
getArrayValue(int addr,
int index)
Get a specific value out of an array.
|
CASImpl |
getBaseCAS() |
Feature |
getBeginFeature()
Get the feature object for the annotation begin feature.
|
boolean |
getBooleanValue(int addr,
int feat) |
byte |
getByteValue(int addr,
int feat) |
CAS |
getCAS()
Return a non-admin version of the CAS.
|
int |
getCasId() |
int |
getCasResets() |
ConstraintFactory |
getConstraintFactory()
Get a constraint factory.
|
MarkerImpl |
getCurrentMark() |
CAS |
getCurrentView()
Get the Cas view that the current component should use.
|
<T extends AnnotationFS> |
getDocumentAnnotation()
Generic issue: The returned document annotation could be either an instance of
DocumentAnnotation or an instance of AnnotationImpl - the Java cover class used for
annotations when JCas is not being used.
|
String |
getDocumentLanguage()
Gets the language code for this document from the language feature of the special instance of
the DocumentationAnnotation associated with this CAS.
|
String |
getDocumentText()
Get the document text.
|
double |
getDoubleValue(int addr,
int feat) |
Feature |
getEndFeature()
Get the feature object for the annotation end feature.
|
JCas |
getExistingJCas()
Internal use only
|
int |
getFeatureOffset(int feat) |
int |
getFeatureValue(int addr,
int feat) |
String |
getFeatureValueAsString(int addr,
int feat) |
float |
getFloatValue(int addr) |
float |
getFloatValue(int addr,
int feat) |
FSClassRegistry |
getFSClassRegistry() |
Heap |
getHeap() |
int |
getHeapValue(int addr)
Get the value of an address on the heap.
|
FSIndexRepository |
getIndexRepository()
Get the index repository.
|
FSIndexRepositoryMgr |
getIndexRepositoryMgr() |
JCas |
getJCas()
Get the JCas for this CAS.
|
JCas |
getJCas(SofaFS aSofa)
Create a JCas view for a Sofa.
|
JCas |
getJCas(SofaID aSofaID)
Deprecated.
|
ClassLoader |
getJCasClassLoader()
Gets the ClassLoader that should be used by the JCas to load the generated FS cover classes for
this CAS.
|
long |
getLongValue(int addr,
int feat) |
LowLevelCAS |
getLowLevelCAS()
Get an instance of the low-level CAS.
|
short |
getShortValue(int addr,
int feat) |
SofaFS |
getSofa()
Get the Sofa feature structure associated with this CAS view.
|
SofaFS |
getSofa(SofaID sofaID)
Deprecated.
|
FeatureStructure |
getSofaDataArray()
Get the Sofa data array.
|
InputStream |
getSofaDataStream()
Get the Sofa data as a byte stream.
|
InputStream |
getSofaDataStream(SofaFS aSofa) |
String |
getSofaDataString()
Get the Sofa Data String (a.k.a.
|
String |
getSofaDataURI()
Get the Sofa data array.
|
int |
getSofaFeat(int addr) |
FSIterator<SofaFS> |
getSofaIterator()
Get iterator for all SofaFS in the CAS.
|
String |
getSofaMimeType()
Get the mime type of the Sofa data being analyzed.
|
int |
getSofaRef() |
String |
getStringForCode(int stringCode) |
String |
getStringValue(int addr,
int feat) |
int |
getTypeCode(int fsAddr) |
TypeSystem |
getTypeSystem()
Return the type system of this CAS instance.
|
TypeSystemImpl |
getTypeSystemImpl() |
TypeSystemMgr |
getTypeSystemMgr()
Return a writable version of the type system.
|
CAS |
getView(int sofaNum) |
CAS |
getView(SofaFS aSofa)
Get the view for a Sofa (subject of analysis).
|
CAS |
getView(String aSofaID)
Get the view for a Sofa (subject of analysis).
|
Iterator<CAS> |
getViewIterator()
Get iterator over all views in this CAS.
|
Iterator<CAS> |
getViewIterator(String localViewNamePrefix)
Get iterator over all views with the given name prefix.
|
String |
getViewName()
Get the view name.
|
void |
initCASIndexes()
Install the standard built-in indexes into the base CAS
|
static float |
int2float(int i) |
boolean |
isAbstractArrayType(int type) |
boolean |
isAbstractArrayType(Type type) |
boolean |
isAnnotationType(Type t) |
boolean |
isArrayType(int type) |
boolean |
isArrayType(Type type) |
boolean |
isBackwardCompatibleCas() |
boolean |
isBooleanArrayType(int type) |
boolean |
isBooleanArrayType(Type type) |
boolean |
isBooleanType(int type) |
boolean |
isBooleanType(Type type) |
boolean |
isByteArrayType(int type) |
boolean |
isByteArrayType(Type type) |
boolean |
isByteType(int type) |
boolean |
isByteType(Type type) |
boolean |
isCasLocked() |
boolean |
isDoubleArrayType(int type) |
boolean |
isDoubleArrayType(Type type) |
boolean |
isDoubleType(int type) |
boolean |
isDoubleType(Type type) |
boolean |
isFloatArrayType(int type) |
boolean |
isFloatArrayType(Type type) |
boolean |
isFloatType(int type) |
boolean |
isFloatType(Type type) |
boolean |
isFSArrayType(int type) |
boolean |
isFSArrayType(Type type) |
boolean |
isIntArrayType(int type) |
boolean |
isIntArrayType(Type type) |
boolean |
isIntType(int type) |
boolean |
isIntType(Type type) |
boolean |
isLongArrayType(int type) |
boolean |
isLongArrayType(Type type) |
boolean |
isLongType(int type) |
boolean |
isLongType(Type type) |
boolean |
isShortArrayType(int type) |
boolean |
isShortArrayType(Type type) |
boolean |
isShortType(int type) |
boolean |
isShortType(Type type) |
boolean |
isStringArrayType(int type) |
boolean |
isStringArrayType(Type type) |
boolean |
isStringType(int type) |
boolean |
isStringType(Type type) |
boolean |
isSubtypeOfAnnotationBaseType(int t) |
int |
ll_copyCharBufferValue(int fsRef,
int featureCode,
char[] buffer,
int start) |
int |
ll_createAnnotation(int typeCode,
int begin,
int end) |
int |
ll_createArray(int typeCode,
int arrayLength)
Create a new array.
|
int |
ll_createArray(int typeCode,
int arrayLength,
boolean doChecks)
Create a new array.
|
int |
ll_createAuxArray(int typeCode,
int arrayLength) |
int |
ll_createBooleanArray(int arrayLength) |
int |
ll_createByteArray(int arrayLength) |
int |
ll_createDocumentAnnotation(int length) |
int |
ll_createDocumentAnnotationNoIndex(int begin,
int end) |
int |
ll_createDoubleArray(int arrayLength) |
int |
ll_createFS(int typeCode)
Create a new FS on the heap.
|
int |
ll_createFS(int typeCode,
boolean doCheck)
Create a new FS on the heap.
|
int |
ll_createFSAnnotCheck(int typeCode) |
int |
ll_createLongArray(int arrayLength) |
int |
ll_createShortArray(int arrayLength) |
int |
ll_getAnnotBegin(int fsRef) |
int |
ll_getAnnotEnd(int fsRef) |
int |
ll_getArraySize(int arrayFsRef)
Get the size of an array.
|
boolean |
ll_getBooleanArrayValue(int fsRef,
int position) |
boolean |
ll_getBooleanArrayValue(int fsRef,
int position,
boolean doTypeChecks) |
boolean |
ll_getBooleanValue(int fsRef,
int featureCode) |
boolean |
ll_getBooleanValue(int fsRef,
int featureCode,
boolean doTypeChecks) |
byte |
ll_getByteArrayValue(int fsRef,
int position) |
byte |
ll_getByteArrayValue(int fsRef,
int position,
boolean doTypeChecks) |
byte |
ll_getByteValue(int fsRef,
int featureCode) |
byte |
ll_getByteValue(int fsRef,
int featureCode,
boolean doTypeChecks) |
int |
ll_getCharBufferValueSize(int fsRef,
int featureCode) |
int |
ll_getDocumentAnnotation() |
double |
ll_getDoubleArrayValue(int fsRef,
int position) |
double |
ll_getDoubleArrayValue(int fsRef,
int position,
boolean doTypeChecks) |
double |
ll_getDoubleValue(int fsRef,
int featureCode) |
double |
ll_getDoubleValue(int fsRef,
int featureCode,
boolean doTypeChecks) |
double |
ll_getDoubleValueFeatOffset(int fsRef,
int featureOffset) |
float |
ll_getFloatArrayValue(int fsRef,
int position)
Get the value of a float array at a certain position.
|
float |
ll_getFloatArrayValue(int fsRef,
int position,
boolean doTypeChecks)
Get the value of a float array at a certain position.
|
float |
ll_getFloatValue(int fsRef,
int featureCode)
Get the value of a float valued feature.
|
float |
ll_getFloatValue(int fsRef,
int featureCode,
boolean doTypeChecks)
Get the value of a float valued feature.
|
<T extends FeatureStructure> |
ll_getFSForRef(int fsRef)
Return a FS object that corresponds to a low-level reference.
|
int |
ll_getFSRef(FeatureStructure fsImpl)
Get the low-level reference from an existing FS object.
|
int |
ll_getFSRefType(int fsRef)
Get the type code for a FS reference.
|
int |
ll_getFSRefType(int fsRef,
boolean doChecks)
Get the type code for a FS reference.
|
LowLevelIndexRepository |
ll_getIndexRepository()
Get the low-level version of the index repository.
|
int |
ll_getIntArrayValue(int fsRef,
int position)
Get the value of an array at a certain position.
|
int |
ll_getIntArrayValue(int fsRef,
int position,
boolean doTypeChecks)
Get the value of an integer array at a certain position.
|
int |
ll_getIntValue(int fsRef,
int featureCode)
Get the value of an integer valued feature.
|
int |
ll_getIntValue(int fsRef,
int featureCode,
boolean doTypeChecks)
Get the value of an integer valued feature.
|
int |
ll_getIntValueFeatOffset(int fsRef,
int featureOffset) |
long |
ll_getLongArrayValue(int fsRef,
int position) |
long |
ll_getLongArrayValue(int fsRef,
int position,
boolean doTypeChecks) |
long |
ll_getLongValue(int offset) |
long |
ll_getLongValue(int fsRef,
int featureCode) |
long |
ll_getLongValue(int fsRef,
int featureCode,
boolean doTypeChecks) |
long |
ll_getLongValueFeatOffset(int fsRef,
int featureOffset) |
int |
ll_getRefArrayValue(int fsRef,
int position)
Get the value of a FS reference array at a certain position.
|
int |
ll_getRefArrayValue(int fsRef,
int position,
boolean doTypeChecks)
Get the value of a FS reference array at a certain position.
|
int |
ll_getRefValue(int fsRef,
int featureCode)
Get the value of a FS reference valued feature.
|
int |
ll_getRefValue(int fsRef,
int featureCode,
boolean doTypeChecks)
Get the value of a FS reference valued feature.
|
int |
ll_getRefValueFeatOffset(int fsRef,
int featureOffset) |
short |
ll_getShortArrayValue(int fsRef,
int position) |
short |
ll_getShortArrayValue(int fsRef,
int position,
boolean doTypeChecks) |
short |
ll_getShortValue(int fsRef,
int featureCode) |
short |
ll_getShortValue(int fsRef,
int featureCode,
boolean doTypeChecks) |
int |
ll_getSofa() |
CASImpl |
ll_getSofaCasView(int addr) |
String |
ll_getSofaDataString(int sofaAddr) |
String |
ll_getSofaID(int sofaRef) |
int |
ll_getSofaNum(int sofaRef) |
String |
ll_getStringArrayValue(int fsRef,
int position)
Get the value of a string array at a certain position.
|
String |
ll_getStringArrayValue(int fsRef,
int position,
boolean doTypeChecks)
Get the value of a string array at a certain position.
|
String |
ll_getStringValue(int fsRef,
int featureCode)
Get the value of a string valued feature.
|
String |
ll_getStringValue(int fsRef,
int featureCode,
boolean doTypeChecks)
Get the value of a string valued feature.
|
String |
ll_getStringValueFeatOffset(int fsRef,
int featureOffset) |
int |
ll_getTypeClass(int typeCode)
Determine the type class of a type.
|
LowLevelTypeSystem |
ll_getTypeSystem()
Get the low-level version of the type system object.
|
boolean |
ll_isRefType(int typeCode)
Checks if the type code is that of a reference type (anything that's not a basic type,
currently Integer, String and Float).
|
void |
ll_setBooleanArrayValue(int fsRef,
int position,
boolean b) |
void |
ll_setBooleanArrayValue(int fsRef,
int position,
boolean value,
boolean doTypeChecks) |
void |
ll_setBooleanValue(int fsRef,
int featureCode,
boolean value) |
void |
ll_setBooleanValue(int fsRef,
int featureCode,
boolean value,
boolean doTypeChecks) |
void |
ll_setByteArrayValue(int fsRef,
int position,
byte value) |
void |
ll_setByteArrayValue(int fsRef,
int position,
byte value,
boolean doTypeChecks) |
void |
ll_setByteValue(int fsRef,
int featureCode,
byte value) |
void |
ll_setByteValue(int fsRef,
int featureCode,
byte value,
boolean doTypeChecks) |
void |
ll_setCharBufferValue(int fsRef,
int featureCode,
char[] buffer,
int start,
int length) |
void |
ll_setCharBufferValue(int fsRef,
int featureCode,
char[] buffer,
int start,
int length,
boolean doTypeChecks) |
void |
ll_setDoubleArrayValue(int fsRef,
int position,
double d) |
void |
ll_setDoubleArrayValue(int fsRef,
int position,
double value,
boolean doTypeChecks) |
void |
ll_setDoubleValue(int fsRef,
int featureCode,
double value) |
void |
ll_setDoubleValue(int fsRef,
int featureCode,
double value,
boolean doTypeChecks) |
void |
ll_setFloatArrayValue(int fsRef,
int position,
float value)
Set the value of an integer array at a certain position.
|
void |
ll_setFloatArrayValue(int fsRef,
int position,
float value,
boolean doTypeChecks)
Set the value of an integer array at a certain position.
|
void |
ll_setFloatValue(int fsRef,
int featureCode,
float value)
Set the value of a float feature.
|
void |
ll_setFloatValue(int fsRef,
int featureCode,
float value,
boolean doTypeChecks)
Set the value of a float feature.
|
void |
ll_setIntArrayValue(int fsRef,
int position,
int value)
Set the value of an integer array at a certain position.
|
void |
ll_setIntArrayValue(int fsRef,
int position,
int value,
boolean doTypeChecks)
Set the value of an integer array at a certain position.
|
void |
ll_setIntValue(int fsRef,
int featureCode,
int value)
Set the value of an integer feature.
|
void |
ll_setIntValue(int fsRef,
int featureCode,
int value,
boolean doTypeChecks)
Set the value of an integer feature.
|
void |
ll_setLongArrayValue(int fsRef,
int position,
long value) |
void |
ll_setLongArrayValue(int fsRef,
int position,
long value,
boolean doTypeChecks) |
void |
ll_setLongValue(int fsRef,
int featureCode,
long value) |
void |
ll_setLongValue(int fsRef,
int featureCode,
long value,
boolean doTypeChecks) |
void |
ll_setRefArrayValue(int fsRef,
int position,
int value)
Set the value of an integer array at a certain position.
|
void |
ll_setRefArrayValue(int fsRef,
int position,
int value,
boolean doTypeChecks)
Set the value of an integer array at a certain position.
|
void |
ll_setRefValue(int fsRef,
int featureCode,
int value)
Set the value of a FS reference feature.
|
void |
ll_setRefValue(int fsRef,
int featureCode,
int value,
boolean doTypeChecks)
Set the value of a FS reference feature.
|
void |
ll_setShortArrayValue(int fsRef,
int position,
short value) |
void |
ll_setShortArrayValue(int fsRef,
int position,
short value,
boolean doTypeChecks) |
void |
ll_setShortValue(int fsRef,
int featureCode,
short value) |
void |
ll_setShortValue(int fsRef,
int featureCode,
short value,
boolean doTypeChecks) |
void |
ll_setStringArrayValue(int fsRef,
int position,
String value)
Set the value of an integer array at a certain position.
|
void |
ll_setStringArrayValue(int fsRef,
int position,
String value,
boolean doTypeChecks)
Set the value of an integer array at a certain position.
|
void |
ll_setStringValue(int fsRef,
int featureCode,
String value)
Set the value of a string feature.
|
void |
ll_setStringValue(int fsRef,
int featureCode,
String value,
boolean doTypeChecks)
Set the value of a string feature.
|
static double |
long2double(long l) |
AutoCloseable |
protectIndexes()
protectIndexes
Within the scope of protectIndexes,
feature updates are checked, and if found to be a key, and the FS is in a corruptable index,
then the FS is removed from the indexes (in all necessary views) (perhaps multiple times
if the FS was added to the indexes multiple times), and this removal is recorded on
an new instance of FSsTobeReindexed appended to fssTobeAddedback.
|
void |
protectIndexes(Runnable r)
Runs the code in the runnable inside a protection block, where any modifications to features
done while in this block will be done in a way to protect any indexes which otherwise
might become corrupted by the update action; the protection is achieved by temporarily
removing the FS (if it is in the indexes), before the update happens.
|
void |
reinit(CASCompleteSerializer casCompSer) |
void |
reinit(CASSerializer ser) |
SerialFormat |
reinit(CommonSerDes.Header h,
InputStream istream,
CASMgrSerializer casMgrSerializer,
CasLoadMode casLoadMode,
BinaryCasSerDes6 f6,
AllowPreexistingFS allowPreexistingFS,
TypeSystemImpl ts)
---------------------------------------------------------------------
Deserialize a binary input stream, after reading the header,
and optionally an externally provided type system and index spec
used in compressed form 6 serialization previously
This reads in and deserializes CAS data from a stream.
|
SerialFormat |
reinit(InputStream istream)
---------------------------------------------------------------------
see Blob Format in CASSerializer
This reads in and deserializes CAS data from a stream.
|
void |
release()
Default implementation that returns this CAS to its CasManager by calling
CasOwner.releaseCas(AbstractCas) . |
void |
removeFsFromIndexes(FeatureStructure fs)
Remove a feature structure from all indexes in the repository associated with this CAS View.
|
void |
reset()
Reset the CAS, emptying it of all content.
|
void |
resetNoQuestions() |
void |
restoreClassLoaderUnlockCas() |
void |
setCacheNotInIndex(int fsAddr)
Called by feature setters which know the FS is not in any index
to bypass any index corruption checking, e.g., CasCopier
Internal use only
|
void |
setCAS(CAS cas) |
boolean |
setCasState(CasState state) |
void |
setCurrentComponentInfo(ComponentInfo info)
Informs the CAS of relevant information about the component that is currently processing it.
|
void |
setDocumentLanguage(String languageCode)
Sets the language for this document.
|
void |
setDocumentText(String text)
Set the document text.
|
void |
setFeatureValue(int addr,
int feat,
boolean v) |
void |
setFeatureValue(int addr,
int feat,
byte v) |
void |
setFeatureValue(int addr,
int feat,
double s) |
void |
setFeatureValue(int addr,
int feat,
float f) |
void |
setFeatureValue(int addr,
int feat,
int val)
This is the common point where all sets of values in the heap come through
It implements the check for invalid feature setting and potentially the addback.
|
void |
setFeatureValue(int addr,
int feat,
long s) |
void |
setFeatureValue(int addr,
int feat,
short s) |
void |
setFeatureValueFromString(int fsref,
int feat,
String value) |
void |
setFloatValue(int addr,
int feat,
float f) |
void |
setJCasClassLoader(ClassLoader classLoader)
Sets the ClassLoader that should be used by the JCas to load the generated FS cover classes for
this CAS.
|
void |
setLocalFsGenerators(FSGenerator<? extends FeatureStructure>[] fsGenerators) |
void |
setOwner(CasOwner aCasOwner)
Provides this CAS with a handle to the CASOwner that owns it.
|
void |
setSofaDataArray(FeatureStructure array,
String mime)
Set the Sofa data as an ArrayFS.
|
void |
setSofaDataString(String text,
String mime)
Set the document text.
|
void |
setSofaDataURI(String uri,
String mime)
Set the Sofa data as a URI.
|
void |
setSofaFeat(int addr,
int sofa) |
void |
setStringValue(int addr,
int feat,
String s) |
CASImpl |
setupCasFromCasMgrSerializer(CASMgrSerializer casMgrSerializer) |
static void |
setupTSDefault(TypeSystemImpl ts) |
int |
size()
Estimate the memory consumption of this CAS instance (in bytes).
|
void |
switchClassLoader(ClassLoader newClassLoader,
boolean wasLocked) |
void |
switchClassLoaderLockCas(Object userCode) |
void |
switchClassLoaderLockCasCL(ClassLoader newClassLoader) |
String |
toString() |
void |
updateDocumentAnnotation() |
boolean |
usingBaseClassLoader() |
public static final boolean traceFSs
public static final int NULL
public static final int TRUE
public static final int FALSE
public static final int DEFAULT_INITIAL_HEAP_SIZE
public static final int DEFAULT_RESET_HEAP_SIZE
public static final String THROW_EXCEPTION_FS_UPDATES_CORRUPTS
Users can use the protectIndexes() methods to explicitly control this remove - add back cycle, for instance to "batch" together several updates to multiple features in a FS.
Some build processes may want to FAIL if any unprotected updates of this kind occur, instead of having the framework silently recover them. This is enabled by having the framework throw an exception; this is controlled by this global JVM property, which, if defined, causes the framework to throw an exception rather than recover.
public static final boolean IS_THROW_EXCEPTION_CORRUPT_INDEX
public static final String REPORT_FS_UPDATES_CORRUPTS
public static final String DISABLE_PROTECT_INDEXES
public CASImpl(TypeSystemImpl typeSystem, int initialHeapSize, boolean useJcasCache)
public CASImpl()
public CASImpl(int initialHeapSize, boolean useJcasCache)
public CASImpl(CASMgrSerializer ser)
public boolean isCasLocked()
public void setCacheNotInIndex(int fsAddr)
fsAddr
- the address of the feature structurepublic boolean setCasState(CasState state)
state
- to add to the setpublic boolean containsCasState(CasState state)
state
- to see if it is among the items in this setpublic boolean clearCasState(CasState state)
state
- to be removedpublic void enableReset(boolean flag)
CASMgr
CAS.reset()
.enableReset
in interface CASMgr
flag
- true to enable resetpublic TypeSystem getTypeSystem()
CAS
getTypeSystem
in interface CAS
null
if none is available.public ConstraintFactory getConstraintFactory()
CAS
FSMatchConstraints
.getConstraintFactory
in interface CAS
public <T extends FeatureStructure> T createFS(Type type)
CAS
public int ll_createFSAnnotCheck(int typeCode)
public ArrayFS createArrayFS(int length)
CAS
createArrayFS
in interface CAS
length
- The length of the array.public IntArrayFS createIntArrayFS(int length)
CAS
createIntArrayFS
in interface CAS
length
- The length of the array.public FloatArrayFS createFloatArrayFS(int length)
CAS
createFloatArrayFS
in interface CAS
length
- The length of the array.public StringArrayFS createStringArrayFS(int length)
CAS
createStringArrayFS
in interface CAS
length
- The length of the array.public final void checkArrayPreconditions(int len) throws CASRuntimeException
CASRuntimeException
public boolean isBackwardCompatibleCas()
@Deprecated public SofaFS createSofa(SofaID sofaID, String mimeType)
CAS
createSofa
in interface CAS
sofaID
- -mimeType
- -public void addSofa(FeatureStructure sofa, String sofaName, String mimeType)
@Deprecated public SofaFS getSofa(SofaID sofaID)
CAS
public int ll_getSofaNum(int sofaRef)
public String ll_getSofaID(int sofaRef)
public String ll_getSofaDataString(int sofaAddr)
public CASImpl getBaseCAS()
public FSIterator<SofaFS> getSofaIterator()
CAS
getSofaIterator
in interface CAS
public void setSofaFeat(int addr, int sofa)
public int getSofaFeat(int addr)
public int getSofaRef()
public InputStream getSofaDataStream(SofaFS aSofa)
public <T extends FeatureStructure> FSIterator<T> createFilteredIterator(FSIterator<T> it, FSMatchConstraint cons)
CAS
ConstraintFactory
and related classes.createFilteredIterator
in interface CAS
T
- - the type of the Feature Structureit
- The input iterator.cons
- The constraint specifying what structures should be returned.public void commitTypeSystem()
public void setLocalFsGenerators(FSGenerator<? extends FeatureStructure>[] fsGenerators)
public FSIndexRepositoryMgr getIndexRepositoryMgr()
getIndexRepositoryMgr
in interface CASMgr
@Deprecated public void commitFS(FeatureStructure fs)
public FeaturePath createFeaturePath()
CAS
FSMatchConstraints
.createFeaturePath
in interface CAS
public TypeSystemMgr getTypeSystemMgr()
CASMgr
getTypeSystemMgr
in interface CASMgr
CASMgr.getTypeSystemMgr()
public void reset()
CAS
public void resetNoQuestions()
@Deprecated public void flush()
reset()
instead.CASMgr
public FSIndexRepository getIndexRepository()
CAS
getIndexRepository
in interface CAS
null
if none is available.public void reinit(CASSerializer ser)
public <T extends FeatureStructure> ListIterator<T> fs2listIterator(FSIterator<T> it)
CAS
ListIterator
around an FSListIterator. Use
if you feel more comfortable with java style iterators.fs2listIterator
in interface CAS
T
- The type of FeatureStructureit
- The FSListIterator
to be wrapped.ListIterator
.CAS.fs2listIterator(FSIterator)
public CAS getCAS()
CASMgr
getCAS
in interface CASMgr
CASMgr.getCAS()
public FSClassRegistry getFSClassRegistry()
public CASImpl setupCasFromCasMgrSerializer(CASMgrSerializer casMgrSerializer)
public void reinit(CASCompleteSerializer casCompSer)
public SerialFormat reinit(InputStream istream) throws CASRuntimeException
istream
- -CASRuntimeException
- wraps IOExceptionpublic SerialFormat reinit(CommonSerDes.Header h, InputStream istream, CASMgrSerializer casMgrSerializer, CasLoadMode casLoadMode, BinaryCasSerDes6 f6, AllowPreexistingFS allowPreexistingFS, TypeSystemImpl ts) throws CASRuntimeException
h
- -istream
- -casMgrSerializer
- null or the Java object representing the externally supplied type
and maybe indexes definition (TSI)casLoadMode
- DEFAULT or REINIT. REINIT required with compressed form 6 to
reinitialize the cas's type system and index definition, for form 6.f6
- only used for form 6 where an instance of BinaryCasSerDes6 has been initializedallowPreexistingFS
- only used for form 6 delta deserializationts
- -CASRuntimeException
- wraps IOExceptionpublic <T extends FeatureStructure> T createFS(int addr)
T
- The Java class associated with this feature structureaddr
- The address of the feature structure to be created.public int ll_getArraySize(int arrayFsRef)
LowLevelCAS
ll_getArraySize
in interface LowLevelCAS
arrayFsRef
- The array reference.public final int getArrayStartAddress(int addr)
addr
- The address of the array.public int getArrayValue(int addr, int index)
addr
- The address of the array.index
- The index of the value we're interested in.index
.ArrayIndexOutOfBoundsException
- -public int getTypeCode(int fsAddr)
public int getHeapValue(int addr)
addr
- The target address.public void setFeatureValue(int addr, int feat, int val)
addr
- The address of the FS.feat
- The code of the feature.val
- The new value for the feature.ArrayIndexOutOfBoundsException
- If the feature is not a legal feature, or it is not
appropriate for the type at the address.public void setStringValue(int addr, int feat, String s)
public void setFloatValue(int addr, int feat, float f)
public int getFeatureValue(int addr, int feat)
public String getStringValue(int addr, int feat)
public float getFloatValue(int addr, int feat)
public float getFloatValue(int addr)
public void setFeatureValue(int addr, int feat, byte v)
public byte getByteValue(int addr, int feat)
public void setFeatureValue(int addr, int feat, boolean v)
public boolean getBooleanValue(int addr, int feat)
public void setFeatureValue(int addr, int feat, short s)
public short getShortValue(int addr, int feat)
public void setFeatureValue(int addr, int feat, long s)
public long getLongValue(int addr, int feat)
public void setFeatureValue(int addr, int feat, float f)
public void setFeatureValue(int addr, int feat, double s)
public double getDoubleValue(int addr, int feat)
public String getFeatureValueAsString(int addr, int feat)
public void setFeatureValueFromString(int fsref, int feat, String value)
public static final float int2float(int i)
public static final int float2int(float f)
public static final double long2double(long l)
public static final long double2long(double d)
public TypeSystemImpl getTypeSystemImpl()
public String getStringForCode(int stringCode)
public boolean isStringType(Type type)
public boolean isAbstractArrayType(Type type)
public boolean isArrayType(Type type)
public boolean isIntArrayType(Type type)
public boolean isFloatArrayType(Type type)
public boolean isStringArrayType(Type type)
public boolean isBooleanArrayType(Type type)
public boolean isByteArrayType(Type type)
public boolean isShortArrayType(Type type)
public boolean isLongArrayType(Type type)
public boolean isDoubleArrayType(Type type)
public boolean isFSArrayType(Type type)
public boolean isIntType(Type type)
public boolean isFloatType(Type type)
public boolean isStringType(int type)
public boolean isByteType(Type type)
public boolean isBooleanType(Type type)
public boolean isShortType(Type type)
public boolean isLongType(Type type)
public boolean isDoubleType(Type type)
public boolean isAbstractArrayType(int type)
public boolean isArrayType(int type)
public boolean isIntArrayType(int type)
public boolean isFloatArrayType(int type)
public boolean isStringArrayType(int type)
public boolean isByteArrayType(int type)
public boolean isBooleanArrayType(int type)
public boolean isShortArrayType(int type)
public boolean isLongArrayType(int type)
public boolean isDoubleArrayType(int type)
public boolean isFSArrayType(int type)
public boolean isIntType(int type)
public boolean isFloatType(int type)
public boolean isByteType(int type)
public boolean isBooleanType(int type)
public boolean isShortType(int type)
public boolean isLongType(int type)
public boolean isDoubleType(int type)
public Heap getHeap()
public int getFeatureOffset(int feat)
public static void setupTSDefault(TypeSystemImpl ts)
public void initCASIndexes() throws CASException
CASMgr
initCASIndexes
in interface CASMgr
CASException
- if an error occursCASMgr.initCASIndexes()
public CAS getView(int sofaNum)
public CAS getCurrentView()
CAS
getCurrentView
in interface CAS
public JCas getJCas() throws CASException
CAS
getJCas
in interface CAS
CASException
- -public JCas getExistingJCas()
public JCas getJCas(SofaFS aSofa) throws CASException
CAS
getJCas
in interface CAS
aSofa
- a Sofa feature structure in this CAS.CASException
- -@Deprecated public JCas getJCas(SofaID aSofaID) throws CASException
CAS
getView(aSofaID).getJCas()
.getJCas
in interface CAS
aSofaID
- the ID of a Sofa defined in this CASaSofaID
.CASException
- if no Sofa with the given ID exists in this CASpublic CAS createView(String aSofaID)
CAS
This method creates the underlying Sofa feature structure, but does not set the Sofa data.
Setting ths Sofa data must be done by calling CAS.setSofaDataArray(FeatureStructure, String)
,
CAS.setSofaDataString(String, String)
or CAS.setSofaDataURI(String, String)
on the
CAS view returned by this method.
createView
in interface CAS
aSofaID
- the local name, before any sofa name mapping is done, for this view (note: this is the
same as the associated Sofa name).public CAS getView(String aSofaID)
CAS
public CAS getView(SofaFS aSofa)
CAS
public LowLevelTypeSystem ll_getTypeSystem()
LowLevelCAS
ll_getTypeSystem
in interface LowLevelCAS
public LowLevelIndexRepository ll_getIndexRepository()
LowLevelCAS
ll_getIndexRepository
in interface LowLevelCAS
public final void checkTypingConditions(Type domType, Type ranType, Feature feat)
domType
- domain typeranType
- range typefeat
- featurepublic final boolean ll_isRefType(int typeCode)
LowLevelCAS
ll_isRefType
in interface LowLevelCAS
typeCode
- The type code to check.true
iff typeCode
is the type code of a reference type.public final int ll_getTypeClass(int typeCode)
LowLevelCAS
TYPE_CLASS_INVALID
-- Not a valid type code.TYPE_CLASS_INT
-- Integer type. TYPE_CLASS_FLOAT
-- Float type.TYPE_CLASS_STRING
-- String type.TYPE_CLASS_BOOLEAN
-- Boolean type.TYPE_CLASS_BYTE
-- Byte type.TYPE_CLASS_SHORT
-- Short type.TYPE_CLASS_LONG
-- Long type.TYPE_CLASS_DOUBLE
-- Double type.TYPE_CLASS_INTARRAY
-- Integer array.TYPE_CLASS_FLOATARRAY
-- Float array.TYPE_CLASS_STRINGARRAY
-- String array.TYPE_CLASS_BOOLEANARRAY
-- Boolean array.TYPE_CLASS_BYTEARRAY
-- Byte array.TYPE_CLASS_SHORTARRAY
-- Short array.TYPE_CLASS_LONGARRAY
-- Long array.TYPE_CLASS_DOUBLEARRAY
-- Double array.TYPE_CLASS_FSARRAY
-- FS array.TYPE_CLASS_FS
-- FS type, i.e., all other types, including all user-defined
types.ll_getTypeClass
in interface LowLevelCAS
typeCode
- The type code.TYPE_CLASS_INVALID
if the type code
argument does not represent a valid type code.public final int ll_createFS(int typeCode)
LowLevelCAS
ll_createFS
in interface LowLevelCAS
typeCode
- The low-level code of the type of the FS that should be created. If the
typeCode
is not a valid type code, the results of this call are
undefined.public final int ll_createFS(int typeCode, boolean doCheck)
LowLevelCAS
ll_createFS
in interface LowLevelCAS
typeCode
- The low-level code of the type of the FS that should be created. If the
typeCode
is not a valid type code and the type check flag is not set,
the results of this call are undefined.doCheck
- -public int createTempArray(int type, int len)
type
- The type code of the array to be created.len
- The length of the array to be created.ArrayIndexOutOfBoundsException
- If type
is not a type.public int ll_createArray(int typeCode, int arrayLength)
LowLevelCAS
ll_createArray
in interface LowLevelCAS
typeCode
- The type code of the array type. If this is not a valid array type code, the behavior
of this call is undefined. Only works for arrays where a value is kept in the main
heap (use other ll_createXxxArray for boolean, byte, short, long, and double)arrayLength
- The length of the array to be created.public int ll_createAuxArray(int typeCode, int arrayLength)
public int ll_createByteArray(int arrayLength)
ll_createByteArray
in interface LowLevelCAS
public int ll_createBooleanArray(int arrayLength)
ll_createBooleanArray
in interface LowLevelCAS
public int ll_createShortArray(int arrayLength)
ll_createShortArray
in interface LowLevelCAS
public int ll_createLongArray(int arrayLength)
ll_createLongArray
in interface LowLevelCAS
public int ll_createDoubleArray(int arrayLength)
ll_createDoubleArray
in interface LowLevelCAS
public int ll_createArray(int typeCode, int arrayLength, boolean doChecks)
LowLevelCAS
ll_createArray
in interface LowLevelCAS
typeCode
- The type code of the array to be created.arrayLength
- The length of the array to be created.doChecks
- Switch to turn on various sanity checks.public final int ll_getFSRef(FeatureStructure fsImpl)
LowLevelCAS
ll_getFSRef
in interface LowLevelCAS
fsImpl
- The FS object for which we want the reference.public <T extends FeatureStructure> T ll_getFSForRef(int fsRef)
LowLevelCAS
ll_getFSForRef
in interface LowLevelCAS
T
- the Java class for the Feature StructurefsRef
- The FS reference.public final int ll_getIntValue(int fsRef, int featureCode)
LowLevelCAS
ll_getIntValue
in interface LowLevelCAS
fsRef
- The reference to the FS from which to obtain the feature value.featureCode
- The low-level code of the feature whose value is to be returned.public final int ll_getIntValueFeatOffset(int fsRef, int featureOffset)
public final float ll_getFloatValue(int fsRef, int featureCode)
LowLevelCAS
ll_getFloatValue
in interface LowLevelCAS
fsRef
- The reference to the FS from which to obtain the feature value.featureCode
- The low-level code of the feature whose value is to be returned.public final String ll_getStringValue(int fsRef, int featureCode)
LowLevelCAS
ll_getStringValue
in interface LowLevelCAS
fsRef
- The reference to the FS from which to obtain the feature value.featureCode
- The low-level code of the feature whose value is to be returned.public final String ll_getStringValueFeatOffset(int fsRef, int featureOffset)
public final int ll_getRefValue(int fsRef, int featureCode)
LowLevelCAS
ll_getRefValue
in interface LowLevelCAS
fsRef
- The reference to the FS from which to obtain the feature value.featureCode
- The low-level code of the feature whose value is to be returned.public final int ll_getRefValueFeatOffset(int fsRef, int featureOffset)
public final int ll_getIntValue(int fsRef, int featureCode, boolean doTypeChecks)
LowLevelCAS
ll_getIntValue
in interface LowLevelCAS
fsRef
- The reference to the FS from which to obtain the feature value.featureCode
- The low-level code of the feature whose value is to be returned.doTypeChecks
- Switch to turn on type checking.public final float ll_getFloatValue(int fsRef, int featureCode, boolean doTypeChecks)
LowLevelCAS
ll_getFloatValue
in interface LowLevelCAS
fsRef
- The reference to the FS from which to obtain the feature value.featureCode
- The low-level code of the feature whose value is to be returned.doTypeChecks
- Switch to turn on type checking.public final String ll_getStringValue(int fsRef, int featureCode, boolean doTypeChecks)
LowLevelCAS
ll_getStringValue
in interface LowLevelCAS
fsRef
- The reference to the FS from which to obtain the feature value.featureCode
- The low-level code of the feature whose value is to be returned.doTypeChecks
- Switch to turn on type checking.public final int ll_getRefValue(int fsRef, int featureCode, boolean doTypeChecks)
LowLevelCAS
ll_getRefValue
in interface LowLevelCAS
fsRef
- The reference to the FS from which to obtain the feature value.featureCode
- The low-level code of the feature whose value is to be returned.doTypeChecks
- Switch to turn on type checking.public int ll_getAnnotBegin(int fsRef)
public int ll_getAnnotEnd(int fsRef)
public final void ll_setIntValue(int fsRef, int featureCode, int value)
LowLevelCAS
ll_setIntValue
in interface LowLevelCAS
fsRef
- The reference of the FS on which the feature should be set.featureCode
- The low-level feature code for the feature that should be set.value
- The value to be assigned to the feature.public final void ll_setFloatValue(int fsRef, int featureCode, float value)
LowLevelCAS
ll_setFloatValue
in interface LowLevelCAS
fsRef
- The reference of the FS on which the feature should be set.featureCode
- The low-level feature code for the feature that should be set.value
- The value to be assigned to the feature.public final void ll_setStringValue(int fsRef, int featureCode, String value)
LowLevelCAS
ll_setStringValue
in interface LowLevelCAS
fsRef
- The reference of the FS on which the feature should be set.featureCode
- The low-level feature code for the feature that should be set.value
- The value to be assigned to the feature.public final void ll_setRefValue(int fsRef, int featureCode, int value)
LowLevelCAS
ll_setRefValue
in interface LowLevelCAS
fsRef
- The reference of the FS on which the feature should be set.featureCode
- The low-level feature code for the feature that should be set.value
- The value to be assigned to the feature.public final void ll_setIntValue(int fsRef, int featureCode, int value, boolean doTypeChecks)
LowLevelCAS
ll_setIntValue
in interface LowLevelCAS
fsRef
- The reference of the FS on which the feature should be set.featureCode
- The low-level feature code for the feature that should be set.value
- The value to be assigned to the feature.doTypeChecks
- Switch to turn on type checking.public final void ll_setFloatValue(int fsRef, int featureCode, float value, boolean doTypeChecks)
LowLevelCAS
ll_setFloatValue
in interface LowLevelCAS
fsRef
- The reference of the FS on which the feature should be set.featureCode
- The low-level feature code for the feature that should be set.value
- The value to be assigned to the feature.doTypeChecks
- Switch to turn on type checking.public final void ll_setStringValue(int fsRef, int featureCode, String value, boolean doTypeChecks)
LowLevelCAS
ll_setStringValue
in interface LowLevelCAS
fsRef
- The reference of the FS on which the feature should be set.featureCode
- The low-level feature code for the feature that should be set.value
- The value to be assigned to the feature.doTypeChecks
- Switch to turn on type checking.public final void ll_setCharBufferValue(int fsRef, int featureCode, char[] buffer, int start, int length, boolean doTypeChecks)
ll_setCharBufferValue
in interface LowLevelCAS
public final void ll_setCharBufferValue(int fsRef, int featureCode, char[] buffer, int start, int length)
ll_setCharBufferValue
in interface LowLevelCAS
public int ll_copyCharBufferValue(int fsRef, int featureCode, char[] buffer, int start)
ll_copyCharBufferValue
in interface LowLevelCAS
public int ll_getCharBufferValueSize(int fsRef, int featureCode)
ll_getCharBufferValueSize
in interface LowLevelCAS
public final void ll_setRefValue(int fsRef, int featureCode, int value, boolean doTypeChecks)
LowLevelCAS
ll_setRefValue
in interface LowLevelCAS
fsRef
- The reference of the FS on which the feature should be set.featureCode
- The low-level feature code for the feature that should be set.value
- The value to be assigned to the feature.doTypeChecks
- Switch to turn on type checking.public final int ll_getIntArrayValue(int fsRef, int position)
LowLevelCAS
ll_getIntArrayValue
in interface LowLevelCAS
fsRef
- The reference to the array FS.position
- The position whose value should be returned.position
.public final float ll_getFloatArrayValue(int fsRef, int position)
LowLevelCAS
ll_getFloatArrayValue
in interface LowLevelCAS
fsRef
- The reference to the array FS.position
- The position whose value should be returned.position
.public final String ll_getStringArrayValue(int fsRef, int position)
LowLevelCAS
ll_getStringArrayValue
in interface LowLevelCAS
fsRef
- The reference to the array FS.position
- The position whose value should be returned.position
.public final int ll_getRefArrayValue(int fsRef, int position)
LowLevelCAS
ll_getRefArrayValue
in interface LowLevelCAS
fsRef
- The reference to the array FS.position
- The position whose value should be returned.position
.public final void checkArrayBounds(int fsRef, int pos)
public final void checkArrayBounds(int fsRef, int pos, int length)
public final int ll_getIntArrayValue(int fsRef, int position, boolean doTypeChecks)
LowLevelCAS
ll_getIntArrayValue
in interface LowLevelCAS
fsRef
- The reference to the array FS.position
- The position whose value should be returned.doTypeChecks
- Switch to turn on type checking.position
.public float ll_getFloatArrayValue(int fsRef, int position, boolean doTypeChecks)
LowLevelCAS
ll_getFloatArrayValue
in interface LowLevelCAS
fsRef
- The reference to the array FS.position
- The position whose value should be returned.doTypeChecks
- Switch to turn on type checking.position
.public String ll_getStringArrayValue(int fsRef, int position, boolean doTypeChecks)
LowLevelCAS
ll_getStringArrayValue
in interface LowLevelCAS
fsRef
- The reference to the array FS.position
- The position whose value should be returned.doTypeChecks
- Switch to turn on type checking.position
.public int ll_getRefArrayValue(int fsRef, int position, boolean doTypeChecks)
LowLevelCAS
ll_getRefArrayValue
in interface LowLevelCAS
fsRef
- The reference to the array FS.position
- The position whose value should be returned.doTypeChecks
- Switch to turn on type checking.position
.public void ll_setIntArrayValue(int fsRef, int position, int value, boolean doTypeChecks)
LowLevelCAS
ll_setIntArrayValue
in interface LowLevelCAS
fsRef
- The FS reference of the array.position
- The position whose value will be changed.value
- The new value.doTypeChecks
- Switch to turn on type and bounds checking.public void ll_setFloatArrayValue(int fsRef, int position, float value, boolean doTypeChecks)
LowLevelCAS
ll_setFloatArrayValue
in interface LowLevelCAS
fsRef
- The FS reference of the array.position
- The position whose value will be changed.value
- The new value.doTypeChecks
- Switch to turn on type and bounds checking.public void ll_setStringArrayValue(int fsRef, int position, String value, boolean doTypeChecks)
LowLevelCAS
ll_setStringArrayValue
in interface LowLevelCAS
fsRef
- The FS reference of the array.position
- The position whose value will be changed.value
- The new value.doTypeChecks
- Switch to turn on type and bounds checking.public void ll_setRefArrayValue(int fsRef, int position, int value, boolean doTypeChecks)
LowLevelCAS
ll_setRefArrayValue
in interface LowLevelCAS
fsRef
- The FS reference of the array.position
- The position whose value will be changed.value
- The new value.doTypeChecks
- Switch to turn on type and bounds checking.public void ll_setIntArrayValue(int fsRef, int position, int value)
LowLevelCAS
ll_setIntArrayValue
in interface LowLevelCAS
fsRef
- The FS reference of the array.position
- The position whose value will be changed.value
- The new value.public void ll_setFloatArrayValue(int fsRef, int position, float value)
LowLevelCAS
ll_setFloatArrayValue
in interface LowLevelCAS
fsRef
- The FS reference of the array.position
- The position whose value will be changed.value
- The new value.public void ll_setStringArrayValue(int fsRef, int position, String value)
LowLevelCAS
ll_setStringArrayValue
in interface LowLevelCAS
fsRef
- The FS reference of the array.position
- The position whose value will be changed.value
- The new value.public void ll_setRefArrayValue(int fsRef, int position, int value)
LowLevelCAS
ll_setRefArrayValue
in interface LowLevelCAS
fsRef
- The FS reference of the array.position
- The position whose value will be changed.value
- The new value.public int ll_getFSRefType(int fsRef)
LowLevelCAS
fsRef
is not a fs reference, the results are undefined. There is also a checked version of this call,
which will give better error messages in case of problems.ll_getFSRefType
in interface LowLevelCAS
fsRef
- The FS reference.0
means that the
fsRef is invalid, i.e., NULL_FS_REF
(but see remarks on bounds checking
for this method).public int ll_getFSRefType(int fsRef, boolean doChecks)
LowLevelCAS
ll_getFSRefType
in interface LowLevelCAS
fsRef
- The FS reference.doChecks
- Check fsRef for out-of-range errors. If this switch is not set, and the input
reference is not a valid reference, the results are undefined.0
means that the
fsRef is invalid, i.e., NULL_FS_REF
(but see remarks on bounds checking
for this method).public LowLevelCAS getLowLevelCAS()
CAS
Note: This is for internal use.
getLowLevelCAS
in interface CAS
LowLevelCAS
public int size()
CAS
public ClassLoader getJCasClassLoader()
CASMgr
getJCasClassLoader
in interface CASMgr
public void setJCasClassLoader(ClassLoader classLoader)
CASMgr
setJCasClassLoader
in interface CASMgr
classLoader
- the JCas ClassLoder for this CASpublic void switchClassLoaderLockCas(Object userCode)
public void switchClassLoaderLockCasCL(ClassLoader newClassLoader)
public void switchClassLoader(ClassLoader newClassLoader, boolean wasLocked)
public boolean usingBaseClassLoader()
public void restoreClassLoaderUnlockCas()
public FeatureValuePath createFeatureValuePath(String featureValuePath) throws CASRuntimeException
CAS
createFeatureValuePath
in interface CAS
featureValuePath
- String representation of the feature-value path.CASRuntimeException
- If the input string is not well-formed.public void setOwner(CasOwner aCasOwner)
AbstractCas_ImplBase
setOwner
in class AbstractCas_ImplBase
aCasOwner
- -public void release()
AbstractCas_ImplBase
CasOwner.releaseCas(AbstractCas)
.release
in interface AbstractCas
release
in class AbstractCas_ImplBase
public ByteArrayFS createByteArrayFS(int length) throws CASRuntimeException
CAS
createByteArrayFS
in interface CAS
length
- The length of the array.CASRuntimeException
public BooleanArrayFS createBooleanArrayFS(int length) throws CASRuntimeException
CAS
createBooleanArrayFS
in interface CAS
length
- The length of the array.CASRuntimeException
public ShortArrayFS createShortArrayFS(int length) throws CASRuntimeException
CAS
createShortArrayFS
in interface CAS
length
- The length of the array.CASRuntimeException
public LongArrayFS createLongArrayFS(int length) throws CASRuntimeException
CAS
createLongArrayFS
in interface CAS
length
- The length of the array.CASRuntimeException
public DoubleArrayFS createDoubleArrayFS(int length) throws CASRuntimeException
CAS
createDoubleArrayFS
in interface CAS
length
- The length of the array.CASRuntimeException
public byte ll_getByteValue(int fsRef, int featureCode)
ll_getByteValue
in interface LowLevelCAS
public byte ll_getByteValue(int fsRef, int featureCode, boolean doTypeChecks)
ll_getByteValue
in interface LowLevelCAS
public boolean ll_getBooleanValue(int fsRef, int featureCode)
ll_getBooleanValue
in interface LowLevelCAS
public boolean ll_getBooleanValue(int fsRef, int featureCode, boolean doTypeChecks)
ll_getBooleanValue
in interface LowLevelCAS
public short ll_getShortValue(int fsRef, int featureCode)
ll_getShortValue
in interface LowLevelCAS
public short ll_getShortValue(int fsRef, int featureCode, boolean doTypeChecks)
ll_getShortValue
in interface LowLevelCAS
public long ll_getLongValue(int offset)
public long ll_getLongValue(int fsRef, int featureCode)
ll_getLongValue
in interface LowLevelCAS
public long ll_getLongValueFeatOffset(int fsRef, int featureOffset)
public long ll_getLongValue(int fsRef, int featureCode, boolean doTypeChecks)
ll_getLongValue
in interface LowLevelCAS
public double ll_getDoubleValue(int fsRef, int featureCode)
ll_getDoubleValue
in interface LowLevelCAS
public double ll_getDoubleValueFeatOffset(int fsRef, int featureOffset)
public double ll_getDoubleValue(int fsRef, int featureCode, boolean doTypeChecks)
ll_getDoubleValue
in interface LowLevelCAS
public void ll_setBooleanValue(int fsRef, int featureCode, boolean value)
ll_setBooleanValue
in interface LowLevelCAS
public void ll_setBooleanValue(int fsRef, int featureCode, boolean value, boolean doTypeChecks)
ll_setBooleanValue
in interface LowLevelCAS
public final void ll_setByteValue(int fsRef, int featureCode, byte value)
ll_setByteValue
in interface LowLevelCAS
public void ll_setByteValue(int fsRef, int featureCode, byte value, boolean doTypeChecks)
ll_setByteValue
in interface LowLevelCAS
public final void ll_setShortValue(int fsRef, int featureCode, short value)
ll_setShortValue
in interface LowLevelCAS
public void ll_setShortValue(int fsRef, int featureCode, short value, boolean doTypeChecks)
ll_setShortValue
in interface LowLevelCAS
public void ll_setLongValue(int fsRef, int featureCode, long value)
ll_setLongValue
in interface LowLevelCAS
public void ll_setLongValue(int fsRef, int featureCode, long value, boolean doTypeChecks)
ll_setLongValue
in interface LowLevelCAS
public void ll_setDoubleValue(int fsRef, int featureCode, double value)
ll_setDoubleValue
in interface LowLevelCAS
public void ll_setDoubleValue(int fsRef, int featureCode, double value, boolean doTypeChecks)
ll_setDoubleValue
in interface LowLevelCAS
public byte ll_getByteArrayValue(int fsRef, int position)
ll_getByteArrayValue
in interface LowLevelCAS
public byte ll_getByteArrayValue(int fsRef, int position, boolean doTypeChecks)
ll_getByteArrayValue
in interface LowLevelCAS
public boolean ll_getBooleanArrayValue(int fsRef, int position)
ll_getBooleanArrayValue
in interface LowLevelCAS
public boolean ll_getBooleanArrayValue(int fsRef, int position, boolean doTypeChecks)
ll_getBooleanArrayValue
in interface LowLevelCAS
public short ll_getShortArrayValue(int fsRef, int position)
ll_getShortArrayValue
in interface LowLevelCAS
public short ll_getShortArrayValue(int fsRef, int position, boolean doTypeChecks)
ll_getShortArrayValue
in interface LowLevelCAS
public long ll_getLongArrayValue(int fsRef, int position)
ll_getLongArrayValue
in interface LowLevelCAS
public long ll_getLongArrayValue(int fsRef, int position, boolean doTypeChecks)
ll_getLongArrayValue
in interface LowLevelCAS
public double ll_getDoubleArrayValue(int fsRef, int position)
ll_getDoubleArrayValue
in interface LowLevelCAS
public double ll_getDoubleArrayValue(int fsRef, int position, boolean doTypeChecks)
ll_getDoubleArrayValue
in interface LowLevelCAS
public void ll_setByteArrayValue(int fsRef, int position, byte value)
ll_setByteArrayValue
in interface LowLevelCAS
public void ll_setByteArrayValue(int fsRef, int position, byte value, boolean doTypeChecks)
ll_setByteArrayValue
in interface LowLevelCAS
public void ll_setBooleanArrayValue(int fsRef, int position, boolean b)
ll_setBooleanArrayValue
in interface LowLevelCAS
public void ll_setBooleanArrayValue(int fsRef, int position, boolean value, boolean doTypeChecks)
ll_setBooleanArrayValue
in interface LowLevelCAS
public void ll_setShortArrayValue(int fsRef, int position, short value)
ll_setShortArrayValue
in interface LowLevelCAS
public void ll_setShortArrayValue(int fsRef, int position, short value, boolean doTypeChecks)
ll_setShortArrayValue
in interface LowLevelCAS
public void ll_setLongArrayValue(int fsRef, int position, long value)
ll_setLongArrayValue
in interface LowLevelCAS
public void ll_setLongArrayValue(int fsRef, int position, long value, boolean doTypeChecks)
ll_setLongArrayValue
in interface LowLevelCAS
public void ll_setDoubleArrayValue(int fsRef, int position, double d)
ll_setDoubleArrayValue
in interface LowLevelCAS
public void ll_setDoubleArrayValue(int fsRef, int position, double value, boolean doTypeChecks)
ll_setDoubleArrayValue
in interface LowLevelCAS
public boolean isAnnotationType(Type t)
public boolean isSubtypeOfAnnotationBaseType(int t)
t
- the type code to testpublic AnnotationFS createAnnotation(Type type, int begin, int end)
CAS
createAnnotation
in interface CAS
type
- The type of the annotation.begin
- The start of the annotation.end
- The end of the annotation.public int ll_createAnnotation(int typeCode, int begin, int end)
public <T extends AnnotationFS> AnnotationIndex<T> getAnnotationIndex()
getAnnotationIndex
in interface CAS
T
- the Java class associated with the annotation indexpublic <T extends AnnotationFS> AnnotationIndex<T> getAnnotationIndex(Type type)
CAS
getAnnotationIndex
in interface CAS
T
- the topmost Java class corresponding to the typetype
- The annotation type the index is restricted to.type
.CAS.getAnnotationIndex(Type)
public Type getAnnotationType()
CAS
getAnnotationType
in interface CAS
CAS.getAnnotationType()
public Feature getEndFeature()
CAS
getEndFeature
in interface CAS
CAS.getEndFeature()
public Feature getBeginFeature()
CAS
getBeginFeature
in interface CAS
CAS.getBeginFeature()
public int ll_createDocumentAnnotation(int length)
public int ll_createDocumentAnnotationNoIndex(int begin, int end)
public void updateDocumentAnnotation()
public <T extends AnnotationFS> T getDocumentAnnotation()
getDocumentAnnotation
in interface CAS
T
- the Java class for the document annotation. Could be the JCas cover class or FeatureStructurenull
if there is none. The return value is the
JCas cover class or the plain Java cover class for FeatureStructures if JCas is not in use.public int ll_getDocumentAnnotation()
public String getDocumentLanguage()
CAS
getDocumentLanguage
in interface CAS
public String getDocumentText()
CAS
getDocumentText
in interface CAS
null
if not set.public String getSofaDataString()
CAS
getSofaDataString
in interface CAS
null
if not set.public FeatureStructure getSofaDataArray()
CAS
getSofaDataArray
in interface CAS
null
if not set.public String getSofaDataURI()
CAS
getSofaDataURI
in interface CAS
null
if not set.public InputStream getSofaDataStream()
CAS
getSofaDataStream
in interface CAS
null
if not set.public String getSofaMimeType()
CAS
getSofaMimeType
in interface CAS
public SofaFS getSofa()
CAS
public int ll_getSofa()
ll_getSofa
in interface LowLevelCAS
public String getViewName()
CAS
getViewName
in interface CAS
public void setDocumentLanguage(String languageCode)
CAS
setDocumentLanguage
in interface CAS
languageCode
- -public void setDocumentText(String text)
CAS
setDocumentText
in interface CAS
text
- The text to be analyzed.public void setSofaDataString(String text, String mime) throws CASRuntimeException
CAS
setSofaDataString
in interface CAS
text
- The text to be analyzed.mime
- The mime type of the dataCASRuntimeException
- If the Sofa data has already been set.public void setSofaDataArray(FeatureStructure array, String mime) throws CASRuntimeException
CAS
setSofaDataArray
in interface CAS
array
- The ArrayFS to be analyzed.mime
- The mime type of the dataCASRuntimeException
- If the Sofa data has already been set.public void setSofaDataURI(String uri, String mime) throws CASRuntimeException
CAS
setSofaDataURI
in interface CAS
uri
- The URI of the data to be analyzed.mime
- The mime type of the dataCASRuntimeException
- If the Sofa data has already been set.public void setCurrentComponentInfo(ComponentInfo info)
CAS
setCurrentComponentInfo
in interface CAS
info
- information about the component that is currently processing this CAS.public void addFsToIndexes(FeatureStructure fs)
CAS
Important: after you have called addFsToIndexes(...)
on a FS, do not
change the values of any features used for indexing. If you do, the index will become corrupted
and may be unusable. If you need to change an index feature value, first call
removeFsFromIndexes(...)
on the FS, change the
feature values, then call addFsToIndexes(...)
again.
addFsToIndexes
in interface CAS
fs
- The Feature Structure to be added.CAS.addFsToIndexes(FeatureStructure fs)
public void removeFsFromIndexes(FeatureStructure fs)
CAS
removeFsFromIndexes
in interface CAS
fs
- The Feature Structure to be removed.CAS.removeFsFromIndexes(FeatureStructure fs)
public CASImpl ll_getSofaCasView(int addr)
ll_getSofaCasView
in interface LowLevelCAS
addr
- the heap address of a feature structure which is a subtype of AnnotationBasepublic Iterator<CAS> getViewIterator()
CAS
getViewIterator
in interface CAS
public Iterator<CAS> getViewIterator(String localViewNamePrefix)
CAS
When passed the prefix namePrefix, the iterator will return all views who
name is either exactly equal to namePrefix or is of the form
namePrefix.
suffix, where suffix can be any String.
getViewIterator
in interface CAS
localViewNamePrefix
- the local name prefix, before any sofa name mapping
is done, for this view (note: this is the same as the associated Sofa name prefix).public final boolean doUseJcasCache()
public AutoCloseable protectIndexes()
protectIndexes
in interface CAS
public void protectIndexes(Runnable r)
CAS
protectIndexes
in interface CAS
r
- an inner block of code to be run withpublic Marker createMarker()
createMarker
in interface CAS
public MarkerImpl getCurrentMark()
public int getCasResets()
public int getCasId()
Copyright © 2006–2021 The Apache Software Foundation. All rights reserved.