Class CASImpl
- All Implemented Interfaces:
AbstractCas,CASMgr,CAS,LowLevelCAS,TypeSystemConstants
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classJournaling changes for computing delta cas. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final intstatic final intstatic final StringSet 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 final intstatic booleanstatic final intstatic final StringDefine this JVM property to enable checking for invalid updates to features which are used as keys by any index.static final StringThe UIMA framework detects (unless disabled, for high performance) updates to indexed FS which update key values used as keys in indexes.static final booleanstatic final booleanstatic final intFields inherited from interface org.apache.uima.cas.CAS
DEFAULT_LANGUAGE_NAME, FEATURE_BASE_NAME_BEGIN, FEATURE_BASE_NAME_END, FEATURE_BASE_NAME_FS_ARRAY, FEATURE_BASE_NAME_HEAD, FEATURE_BASE_NAME_INT_ARRAY, 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, UIMA_TCAS_PREFIXFields inherited from interface org.apache.uima.cas.impl.LowLevelCAS
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_STRINGARRAYFields inherited from interface org.apache.uima.cas.impl.TypeSystemConstants
annotBaseSofaFeatAdjOffset, annotBaseSofaFeatCode, annotBaseTypeCode, annotTypeCode, arrayBaseTypeCode, beginFeatAdjOffset, beginFeatCode, booleanArrayTypeCode, booleanTypeCode, byteArrayTypeCode, byteTypeCode, docTypeCode, doubleArrayTypeCode, doubleTypeCode, endFeatAdjOffset, endFeatCode, floatArrayTypeCode, floatEListTypeCode, floatListTypeCode, floatNeListTypeCode, floatTypeCode, fsArrayTypeCode, fsEListTypeCode, fsListTypeCode, fsNeListTypeCode, intArrayTypeCode, intEListTypeCode, intListTypeCode, intNeListTypeCode, intTypeCode, langFeatAdjOffset, langFeatCode, longArrayTypeCode, longTypeCode, shortArrayTypeCode, shortTypeCode, sofaArrayFeatAdjOffset, sofaArrayFeatCode, sofaIdFeatAdjOffset, sofaIdFeatCode, sofaMimeFeatAdjOffset, sofaMimeFeatCode, sofaNumFeatAdjOffset, sofaNumFeatCode, sofaStringFeatAdjOffset, sofaStringFeatCode, sofaTypeCode, sofaUriFeatAdjOffset, sofaUriFeatCode, stringArrayTypeCode, stringEListTypeCode, stringListTypeCode, stringNeListTypeCode, stringTypeCode, topTypeCode -
Constructor Summary
ConstructorsConstructorDescriptionCASImpl()CASImpl(CASMgrSerializer ser) CASImpl(TypeSystemImpl typeSystem, int initialHeapSize) -
Method Summary
Modifier and TypeMethodDescriptionvoidAdd a feature structure to all appropriate indexes in the repository associated with this CAS View.voidadjustLastFsV2Size_arrays(int arrayLength) voidfinal voidCall this to capture the current value of fsIdGenerator and make it available to other threads.final voidcheckArrayBounds(int fsRef, int pos) final voidcheckArrayBounds(int arrayLength, int pos, int length) final voidcheckArrayPreconditions(int len) final voidcheckTypingConditions(Type domType, Type ranType, Feature feat) Check the range is appropriate for this type/feature.booleanclearCasState(CasState state) Collection<?>voidDeprecated.commitTypeSystem(boolean skip_loading_user_jcas) booleancontainsCasState(CasState state) static CommonArrayFSstatic booleancopyFeatureExceptFsRef(TOP fsSrc, FeatureImpl fiSrc, TOP fsTgt, FeatureImpl fiTgt) Copies a feature from one fs to another FSs may be in different type systems Doesn't copy a feature ref, but instead returns false.createAnnotation(Type type, int begin, int end) Create a new annotation.createArray(TypeImpl array_type, int arrayLength) createArrayFS(int length) Create a new feature structure array.createBooleanArrayFS(int length) Create a new Boolean array.createByteArrayFS(int length) Create a new Byte array.<T extends Annotation>
TcreateDocumentAnnotationNoRemoveNoIndex(int length) createDoubleArrayFS(int length) Create a new Double array.Create a feature path.createFeatureValuePath(String featureValuePath) Create a feature-value path from a string.<T extends FeatureStructure>
FSIterator<T>createFilteredIterator(FSIterator<T> it, FSMatchConstraint cons) Create an iterator over structures satisfying a given constraint.createFloatArrayFS(int length) Create a new int array.<T extends TOP>
TcreateFS(int id) This is your link from the low-level API to the high-level API.<T extends FeatureStructure>
TCreate the appropriate Feature Structure Java instance - from whatever the generator for this type specifies.createIntArrayFS(int length) Create a new int array.createLongArrayFS(int length) Create a new Long array.The current implementation only supports 1 marker call per CAS.createShortArrayFS(int length) Create a new Short array.createSofa(SofaID sofaID, String mimeType) Deprecated.createStringArrayFS(int length) Create a new String array.intcreateTempArray(int type, int len) (for backwards compatibility with V2 CASImpl) Create a temporary (i.e., per document) array FS on the heap.createView(String aSofaID) Create a view and its underlying Sofa (subject of analysis).voidA space-freeing optimization for use cases where (multiple) delta CASes are being deserialized into this CAS and merged.static final longdouble2long(double d) emptyArray(Type type) <T extends FeatureStructure>
FSArray<T><T extends FeatureStructure>
FSArray<T>emptyFSArray(Type type) <T extends TOP>
EmptyFSList<T>emptyList(int rangeCode) emptyListFromTypeCode(int typeCode) Get an empty list from the type code of a listvoidenableReset(boolean flag) Enable/disable resetting the CAS withCAS.reset().static final intfloat2int(float f) voidflush()Deprecated.voidforAllViews(Consumer<CASImpl> processViews) iterate over all views in view order (by view number)<T extends FeatureStructure>
ListIterator<T>fs2listIterator(FSIterator<T> it) Wrap a standard JavaListIteratoraround an FSListIterator.<T extends AnnotationFS>
AnnotationIndex<T>The generic spec T extends AnnotationFS (rather than AnnotationFS) allows the method JCasImpl getAnnotationIndex to return Annotation instead of AnnotationFS<T extends AnnotationFS>
AnnotationIndex<T>getAnnotationIndex(Type type) Get the standard annotation index restricted to a specific annotation type.Get the type object for the annotation type.intGet the feature object for the annotation begin feature.getCAS()Return a non-admin version of the CAS.getCasId()intGet a constraint factory.Get the Cas view that the current component should use.static ThreadLocal<Boolean><T extends AnnotationFS>
TGeneric issue: The returned document annotation could be either an instance of DocumentAnnotation or a subclass of it, or an instance of Annotation - the Java cover class used for annotations when JCas is not being used.<T extends AnnotationFS>
TGets the language code for this document from the language feature of the special instance of the DocumentationAnnotation associated with this CAS.Get the document text.Get the feature object for the annotation end feature.final floatgetFloatArrayValue(FloatArray array, int i) <T extends TOP>
TgetFsFromId(int id) final <T extends TOP>
TgetFsFromId_checked(int fsRef) Get the index repository.intfinal intgetIntArrayValue(IntegerArray array, int i) getJCas()Get the JCas view for this CAS viewCreate a JCas view for a Sofa.Deprecated.Gets the ClassLoader that should be used by the JCas to load the generated FS cover classes for this CAS.Get the JCasImpl view for this CAS viewfinal intGet an instance of the low-level CAS.final intgetNextFsId(TOP fs) intintCreates the initial view (without a sofa) if not presentfinal FeatureStructuregetRefArrayValue(FSArray array, int i) getSofa()Get the Sofa feature structure associated with this CAS view.Deprecated.Get the Sofa data array.Get the Sofa data as a byte stream.getSofaDataStream(SofaFS aSofa) Get the Sofa Data String (a.k.a.Get the Sofa data array.<T extends SofaFS>
FSIterator<T>Get iterator for all SofaFS in the CAS.Get the mime type of the Sofa data being analyzed.final StringgetStringArrayValue(StringArray array, int i) final TypeSystemReturn the type system of this CAS instance.final TypeSystemImplReturn a writable version of the type system.getView(int sofaNum) Get the view for a Sofa (subject of analysis).Get the view for a Sofa (subject of analysis).excludes initial view if its sofa is not validGet iterator over all views in this CAS.getViewIterator(String localViewNamePrefix) Get iterator over all views with the given name prefix.Get the view name.voidInstall the standard built-in indexes into the base CASstatic final floatint2float(int i) booleanfinal booleanisAbstractArrayType(Type type) booleanfinal booleanisArrayType(Type type) booleanbooleanfinal booleanisBooleanArrayType(Type type) final booleanisBooleanType(Type type) final booleanisByteArrayType(Type type) final booleanisByteType(Type type) booleanfinal booleanisDoubleArrayType(Type type) final booleanisDoubleType(Type type) final booleanisFloatArrayType(Type type) final booleanisFloatType(Type type) final booleanisFSArrayType(Type type) booleanisId2Fs()booleanfinal booleanisIntArrayType(Type type) final booleanfinal booleanfinal booleanfinal booleanisLongArrayType(Type type) final booleanisLongType(Type type) final booleanisPrimitiveArrayType(Type type) static final booleanfinal booleanisShortArrayType(Type type) final booleanisShortType(Type type) final booleanisStringArrayType(Type type) final booleanisStringType(Type type) booleanfinal intintll_copyCharBufferValue(int fsRef, int featureCode, char[] buffer, int start) intll_createAnnotation(int typeCode, int begin, int end) intll_createArray(int typeCode, int arrayLength) Create a new array.intll_createArray(int typeCode, int arrayLength, boolean doChecks) Create a new array.intll_createBooleanArray(int arrayLength) intll_createByteArray(int arrayLength) intll_createDocumentAnnotation(int length) intll_createDocumentAnnotationNoIndex(int begin, int end) intll_createDoubleArray(int arrayLength) final intll_createFS(int typeCode) Create a new FS on the heap.final intll_createFS(int typeCode, boolean doCheck) Create a new FS on the heap.intll_createLongArray(int arrayLength) intll_createShortArray(int arrayLength) ll_enableV2IdRefs(boolean enable) Enables or disables the id_to_fs_map mode.intll_getArraySize(int id) Get the size of an array.booleanll_getBooleanArrayValue(int fsRef, int position) booleanll_getBooleanArrayValue(int fsRef, int position, boolean doTypeChecks) booleanll_getBooleanValue(int fsRef, int featureCode) booleanll_getBooleanValue(int fsRef, int featureCode, boolean doTypeChecks) bytell_getByteArrayValue(int fsRef, int position) bytell_getByteArrayValue(int fsRef, int position, boolean doTypeChecks) bytell_getByteValue(int fsRef, int featureCode) bytell_getByteValue(int fsRef, int featureCode, boolean doTypeChecks) intll_getCharBufferValueSize(int fsRef, int featureCode) intdoublell_getDoubleArrayValue(int fsRef, int position) doublell_getDoubleArrayValue(int fsRef, int position, boolean doTypeChecks) doublell_getDoubleValue(int fsRef, int featureCode) doublell_getDoubleValue(int fsRef, int featureCode, boolean doTypeChecks) final floatll_getFloatArrayValue(int fsRef, int position) Get the value of a float array at a certain position.floatll_getFloatArrayValue(int fsRef, int position, boolean doTypeChecks) Get the value of a float array at a certain position.final floatll_getFloatValue(int fsRef, int featureCode) Get the value of a float valued feature.final floatll_getFloatValue(int fsRef, int featureCode, boolean doTypeChecks) Get the value of a float valued feature.<T extends TOP>
Tll_getFSForRef(int id) Return a FS object that corresponds to a low-level reference.final intSafety - any time the low level API to a FS is requested, hold on to that FS until CAS reset to mimic how v2 works.intll_getFSRefType(int fsRef) Get the type code for a FS reference.intll_getFSRefType(int fsRef, boolean doChecks) Get the type code for a FS reference.Get the low-level version of the index repository.final intll_getIntArrayValue(int fsRef, int position) Get the value of an array at a certain position.final intll_getIntArrayValue(int fsRef, int position, boolean doTypeChecks) Get the value of an integer array at a certain position.final intll_getIntValue(int fsRef, int featureCode) Handle some unusual backwards compatibility cases featureCode = 0 - implies getting the type code feature range is int - normal feature range is a fs reference, return the id feature range is a string: add the string if not already present to the string heap, return the int handle.final intll_getIntValue(int fsRef, int featureCode, boolean doTypeChecks) Get the value of an integer valued feature.longll_getLongArrayValue(int fsRef, int position) longll_getLongArrayValue(int fsRef, int position, boolean doTypeChecks) longll_getLongValue(int fsRef, int featureCode) longll_getLongValue(int fsRef, int featureCode, boolean doTypeChecks) final intll_getRefArrayValue(int fsRef, int position) Get the value of a FS reference array at a certain position.intll_getRefArrayValue(int fsRef, int position, boolean doTypeChecks) Get the value of a FS reference array at a certain position.final intll_getRefValue(int fsRef, int featureCode) Get the value of a FS reference valued feature.final intll_getRefValue(int fsRef, int featureCode, boolean doTypeChecks) Get the value of a FS reference valued feature.shortll_getShortArrayValue(int fsRef, int position) shortll_getShortArrayValue(int fsRef, int position, boolean doTypeChecks) shortll_getShortValue(int fsRef, int featureCode) shortll_getShortValue(int fsRef, int featureCode, boolean doTypeChecks) intll_getSofaCasView(int id) ll_getSofaDataString(int sofaAddr) ll_getSofaID(int sofaRef) intll_getSofaNum(int sofaRef) final Stringll_getStringArrayValue(int fsRef, int position) Get the value of a string array at a certain position.ll_getStringArrayValue(int fsRef, int position, boolean doTypeChecks) Get the value of a string array at a certain position.final Stringll_getStringValue(int fsRef, int featureCode) Get the value of a string valued feature.final Stringll_getStringValue(int fsRef, int featureCode, boolean doTypeChecks) Get the value of a string valued feature.final intll_getTypeClass(int typeCode) Determine the type class of a type.Get the low-level version of the type system object.final booleanll_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).voidll_setBooleanArrayValue(int fsRef, int position, boolean b) voidll_setBooleanArrayValue(int fsRef, int position, boolean value, boolean doTypeChecks) voidll_setBooleanValue(int fsRef, int featureCode, boolean value) voidll_setBooleanValue(int fsRef, int featureCode, boolean value, boolean doTypeChecks) voidll_setByteArrayValue(int fsRef, int position, byte value) voidll_setByteArrayValue(int fsRef, int position, byte value, boolean doTypeChecks) final voidll_setByteValue(int fsRef, int featureCode, byte value) voidll_setByteValue(int fsRef, int featureCode, byte value, boolean doTypeChecks) final voidll_setCharBufferValue(int fsRef, int featureCode, char[] buffer, int start, int length) final voidll_setCharBufferValue(int fsRef, int featureCode, char[] buffer, int start, int length, boolean doTypeChecks) voidll_setDoubleArrayValue(int fsRef, int position, double d) voidll_setDoubleArrayValue(int fsRef, int position, double value, boolean doTypeChecks) voidll_setDoubleValue(int fsRef, int featureCode, double value) voidll_setDoubleValue(int fsRef, int featureCode, double value, boolean doTypeChecks) voidll_setFloatArrayValue(int fsRef, int position, float value) Set the value of an integer array at a certain position.voidll_setFloatArrayValue(int fsRef, int position, float value, boolean doTypeChecks) Set the value of an integer array at a certain position.final voidll_setFloatValue(int fsRef, int featureCode, float value) Set the value of a float feature.final voidll_setFloatValue(int fsRef, int featureCode, float value, boolean doTypeChecks) Set the value of a float feature.voidll_setIntArrayValue(int fsRef, int position, int value) Set the value of an integer array at a certain position.voidll_setIntArrayValue(int fsRef, int position, int value, boolean doTypeChecks) Set the value of an integer array at a certain position.final voidll_setIntValue(int fsRef, int featureCode, int value) Special considerations: Interface with corruption checking For backwards compatibility: handle cases where feature is: int - normal 0 - change type code a ref: treat int as FS "addr" not an int: handle like v2 where reasonablefinal voidll_setIntValue(int fsRef, int featureCode, int value, boolean doTypeChecks) Set the value of an integer feature.voidll_setLongArrayValue(int fsRef, int position, long value) voidll_setLongArrayValue(int fsRef, int position, long value, boolean doTypeChecks) voidll_setLongValue(int fsRef, int featureCode, long value) voidll_setLongValue(int fsRef, int featureCode, long value, boolean doTypeChecks) voidll_setRefArrayValue(int fsRef, int position, int value) Set the value of an integer array at a certain position.voidll_setRefArrayValue(int fsRef, int position, int value, boolean doTypeChecks) Set the value of an integer array at a certain position.final voidll_setRefValue(int fsRef, int featureCode, int value) Set the value of a FS reference feature.final voidll_setRefValue(int fsRef, int featureCode, int value, boolean doTypeChecks) Set the value of a FS reference feature.voidll_setShortArrayValue(int fsRef, int position, short value) voidll_setShortArrayValue(int fsRef, int position, short value, boolean doTypeChecks) final voidll_setShortValue(int fsRef, int featureCode, short value) voidll_setShortValue(int fsRef, int featureCode, short value, boolean doTypeChecks) voidll_setStringArrayValue(int fsRef, int position, String value) Set the value of an integer array at a certain position.voidll_setStringArrayValue(int fsRef, int position, String value, boolean doTypeChecks) Set the value of an integer array at a certain position.final voidll_setStringValue(int fsRef, int featureCode, String value) Set the value of a string feature.final voidll_setStringValue(int fsRef, int featureCode, String value, boolean doTypeChecks) Set the value of a string feature.static final doublelong2double(long l) <T> Spliterator<T>makePearAware(Spliterator<T> baseSi) voidmaybeAddback(TOP fs) Only called if there was something removed that needs to be added back skip the addback (to defer it until later) if: - running in block mode (you can tell this if svd.fssTobeAddedback.size() > 0) or if running in block mode, the add back is delayed until the end of the blockfinal voidmaybeLogArrayUpdate(FeatureStructureImplC fs, FeatureImpl feat, int i) final voidmaybeLogArrayUpdates(FeatureStructureImplC fs, int startingIndex, int length) final voidmaybeLogArrayUpdates(FeatureStructureImplC fs, org.apache.uima.internal.util.PositiveIntSet indexesPlus1) final voidmaybeLogUpdate(FeatureStructureImplC fs, int featCode) final voidmaybeLogUpdate(FeatureStructureImplC fs, FeatureImpl feat) final intprotectIndexes Within the scope of protectIndexes, feature updates are checked, and if found to be a key, and the FS is in a corruptible 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.voidRuns 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.reinit(InputStream istream) --------------------------------------------------------------------- see Blob Format in CASSerializer This reads in and deserializes CAS data from a stream.voidreinit(CASCompleteSerializer casCompSer) Deserializer for CASCompleteSerializer instances - includes type system and index definitions Never deltavoidreinit(CASSerializer ser) Deserializer for Java-object serialized instance of CASSerializer.voidrelease()Default implementation that returns this CAS to its CasManager by callingCasOwner.releaseCas(AbstractCas).voidRemove a feature structure from all indexes in the repository associated with this CAS View.voidreset()Reset the CAS, emptying it of all content.voidvoidvoidset_deserialized_doc_annot_not_indexed(Annotation doc_annot) voidDeprecated.booleansetCasState(CasState state) booleansetCasState(CasState state, Thread thread) voidInforms the CAS of relevant information about the component that is currently processing it.voidsetDocumentLanguage(String languageCode) Sets the language for this document.voidsetDocumentText(String text) Set the document text.static voidsetFeatureValueFromString(FeatureStructureImplC fs, FeatureImpl feat, String s) Supports setting slots to "0" for null valuesstatic voidInternal use, for cases where deserializing - special case setting sofString to skip updating the document annotationstatic voidsetFeatureValueMaybeSofa(TOP fs, FeatureImpl feat, TOP value) internal use - special setter for setting feature values, including special handling if the feature is for the sofaArray, when deserializingvoidTest case usevoidsetJCasClassLoader(ClassLoader classLoader) Sets the ClassLoader that should be used by the JCas to load the generated FS cover classes for this CAS.voidsetLongValue(FeatureStructureImplC fsIn, FeatureImpl feat, long v) version for longs, uses two slots Only called from FeatureStructureImplC after determining there is no local field to use Is here because of 3 calls to things in this classvoidProvides this CAS with a handle to the CASOwner that owns it.voidsetSofaDataArray(FeatureStructure array, String mime) Set the Sofa data as an ArrayFS.voidsetSofaDataString(String text, String mime) Set the document text.voidsetSofaDataURI(String uri, String mime) Set the Sofa data as a URI.final voidsetWithCheckAndJournal(TOP fs, int featCode, Runnable setter) final voidsetWithJournal(FeatureStructureImplC fs, FeatureImpl fi, Runnable setter) This method called by setters in JCas gen'd classes when the setter must check for journalingintsize()Estimate the memory consumption of this CAS instance (in bytes).voidswapInPearVersion(Object[] a) voidswitchClassLoader(ClassLoader newClassLoader, boolean wasLocked) voidswitchClassLoaderLockCas(Object userCode) voidswitchClassLoaderLockCasCL(ClassLoader newClassLoader) toString()voidvoidupdates the document annotation (only if the sofa's local string data != null) setting the end feature to be the length of the sofa string, if any.voidvalidateArraySize(int length) walkReachablePlusFSsSorted(Consumer<TOP> action_filtered, MarkerImpl mark, Predicate<TOP> includeFilter, CasTypeSystemMapper typeMapper) find all of the FSs via the indexes plus what's reachable.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.uima.cas.CAS
emptyArray, emptyList, getAllIndexedFS, getAllIndexedFS, getAnnotationIndex, getCasType, getIndexedFSs, getIndexedFSs, getIndexedFSs, select, select, select, select, selectMethods inherited from interface org.apache.uima.cas.impl.LowLevelCAS
ll_enableV2IdRefs
-
Field Details
-
traceFSs
public static final boolean traceFSs -
traceCow
public static final boolean traceCow- See Also:
-
NULL
public static final int NULL- See Also:
-
TRUE
public static final int TRUE- See Also:
-
FALSE
public static final int FALSE- See Also:
-
DEFAULT_INITIAL_HEAP_SIZE
public static final int DEFAULT_INITIAL_HEAP_SIZE- See Also:
-
DEFAULT_RESET_HEAP_SIZE
public static final int DEFAULT_RESET_HEAP_SIZE- See Also:
-
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. Normally the framework will protect against index corruption by temporarily removing the FS from the indexes, then do the update to the feature value, and then addback the changed FS.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.
- See Also:
-
IS_THROW_EXCEPTION_CORRUPT_INDEX
public static boolean IS_THROW_EXCEPTION_CORRUPT_INDEX -
REPORT_FS_UPDATES_CORRUPTS
Define this JVM property to enable checking for invalid updates to features which are used as keys by any index.- The following are the same: -Duima.check_invalid_fs_updates and -Duima.check_invalid_fs_updates=true
- See Also:
-
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".- See Also:
-
ALWAYS_HOLD_ONTO_FSS
- See Also:
-
-
Constructor Details
-
CASImpl
-
CASImpl
public CASImpl() -
CASImpl
-
-
Method Details
-
getDefaultV2IdRefs
-
setCasState
- Parameters:
state- to add to the set- Returns:
- true if the set changed as a result of this operation
-
setCasState
- Parameters:
state- to add to the setthread- null or the thread to permit access to- Returns:
- true if the set changed as a result of this operation
-
containsCasState
- Parameters:
state- to see if it is among the items in this set- Returns:
- true if the set contains that state
-
clearCasState
- Parameters:
state- to be removed- Returns:
- true if it was present, and is now removed
-
isCasLocked
public boolean isCasLocked() -
isId2Fs
public boolean isId2Fs() -
enableReset
public void enableReset(boolean flag) Description copied from interface:CASMgrEnable/disable resetting the CAS withCAS.reset().- Specified by:
enableResetin interfaceCASMgr- Parameters:
flag- true to enable reset
-
getTypeSystem
Description copied from interface:CASReturn the type system of this CAS instance.- Specified by:
getTypeSystemin interfaceCAS- Returns:
- The type system, or
nullif none is available.
-
getTypeSystemImpl
-
getConstraintFactory
Description copied from interface:CASGet a constraint factory. A constraint factory is a simple way of creatingFSMatchConstraints.- Specified by:
getConstraintFactoryin interfaceCAS- Returns:
- A constraint factory to create new FS constraints.
-
createFS
Create the appropriate Feature Structure Java instance - from whatever the generator for this type specifies. -
createArray
-
createArrayFS
Description copied from interface:CASCreate a new feature structure array.- Specified by:
createArrayFSin interfaceCAS- Parameters:
length- The length of the array.- Returns:
- The new array.
-
createIntArrayFS
Description copied from interface:CASCreate a new int array.- Specified by:
createIntArrayFSin interfaceCAS- Parameters:
length- The length of the array.- Returns:
- The new array.
-
createFloatArrayFS
Description copied from interface:CASCreate a new int array.- Specified by:
createFloatArrayFSin interfaceCAS- Parameters:
length- The length of the array.- Returns:
- The new array.
-
createStringArrayFS
Description copied from interface:CASCreate a new String array.- Specified by:
createStringArrayFSin interfaceCAS- Parameters:
length- The length of the array.- Returns:
- The new array.
-
isBackwardCompatibleCas
public boolean isBackwardCompatibleCas() -
createSofa
Deprecated.Description copied from interface:CASCreate a Subject of Analysis. The new sofaFS is automatically added to the SofaIndex.- Specified by:
createSofain interfaceCAS- Parameters:
sofaID- -mimeType- -- Returns:
- The sofaFS.
-
getSofa
Deprecated.Description copied from interface:CASGet sofaFS for given Subject of Analysis ID. -
ll_getSofaNum
public int ll_getSofaNum(int sofaRef) -
ll_getSofaID
-
ll_getSofaDataString
-
getBaseCAS
-
getSofaIterator
Description copied from interface:CASGet iterator for all SofaFS in the CAS.- Specified by:
getSofaIteratorin interfaceCAS- Type Parameters:
T- generic type of sofa iterator- Returns:
- an iterator over SofaFS.
-
getSofaRef
-
getSofaDataStream
-
createFilteredIterator
public <T extends FeatureStructure> FSIterator<T> createFilteredIterator(FSIterator<T> it, FSMatchConstraint cons) Description copied from interface:CASCreate an iterator over structures satisfying a given constraint. Constraints are described in the javadocs forConstraintFactoryand related classes.- Specified by:
createFilteredIteratorin interfaceCAS- Type Parameters:
T- - the type of the Feature Structure- Parameters:
it- The input iterator.cons- The constraint specifying what structures should be returned.- Returns:
- An iterator over FSs.
-
commitTypeSystem
-
commitTypeSystem
-
getIndexRepositoryMgr
- Specified by:
getIndexRepositoryMgrin interfaceCASMgr- Returns:
- a writable version of the index repository. Note that the type system must be committed before this method can be called.
-
commitFS
Deprecated. -
createFeaturePath
Description copied from interface:CASCreate a feature path. This is mainly useful for creatingFSMatchConstraints.- Specified by:
createFeaturePathin interfaceCAS- Returns:
- A new, empty feature path.
-
getTypeSystemMgr
Description copied from interface:CASMgrReturn a writable version of the type system. This may be used to add new types and features.- Specified by:
getTypeSystemMgrin interfaceCASMgr- Returns:
- A writable version of the type system.
- See Also:
-
reset
public void reset()Description copied from interface:CASReset the CAS, emptying it of all content. Feature structures and iterators will no longer be valid. Note: this method may only be called from an application. Calling it from an annotator will trigger a runtime exception. -
resetNoQuestions
public void resetNoQuestions() -
flush
Deprecated.Usereset()instead.Description copied from interface:CASMgrFlush this CAS instance of all transient data. This will delete all feature structures, but not the type system, the indexes etc. Call before processing a new document. -
getIndexRepository
Description copied from interface:CASGet the index repository.- Specified by:
getIndexRepositoryin interfaceCAS- Returns:
- The index repository, or
nullif none is available.
-
fs2listIterator
Description copied from interface:CASWrap a standard JavaListIteratoraround an FSListIterator. Use if you feel more comfortable with java style iterators.- Specified by:
fs2listIteratorin interfaceCAS- Type Parameters:
T- The type of FeatureStructure- Parameters:
it- TheFSListIteratorto be wrapped.- Returns:
- An equivalent
ListIterator. - See Also:
-
getCAS
Description copied from interface:CASMgrReturn a non-admin version of the CAS. -
getFSClassRegistry
-
createFS
This is your link from the low-level API to the high-level API. Use this method to create a FeatureStructure object from an address. Note that the reverse is not supported by public APIs (i.e., there is currently no way to get at the address of a FeatureStructure. Maybe we will need to change that. The "create" in "createFS" is a misnomer - the FS must already be created.- Type Parameters:
T- The Java class associated with this feature structure- Parameters:
id- The id of the feature structure to be created.- Returns:
- A FeatureStructure object.
-
getArraySize
-
ll_getArraySize
public int ll_getArraySize(int id) Description copied from interface:LowLevelCASGet the size of an array.- Specified by:
ll_getArraySizein interfaceLowLevelCAS- Parameters:
id- The array reference.- Returns:
- The size of the array.
-
setWithCheckAndJournal
-
setWithJournal
This method called by setters in JCas gen'd classes when the setter must check for journaling- Parameters:
fs- -fi- -setter- -
-
isLoggingNeeded
-
maybeLogArrayUpdate
- Parameters:
fs- the Feature Structure being updatedfeat- the feature of fs being updated, or null if fs is a primitive arrayi- the index being updated
-
maybeLogArrayUpdates
public final void maybeLogArrayUpdates(FeatureStructureImplC fs, org.apache.uima.internal.util.PositiveIntSet indexesPlus1) - Parameters:
fs- the Feature Structure being updatedindexesPlus1- - a set of indexes (plus 1) that have been update
-
maybeLogArrayUpdates
- Parameters:
fs- a primitive array FSstartingIndex- -length- number of consequtive items
-
maybeLogUpdate
-
maybeLogUpdate
-
isLogging
public final boolean isLogging() -
setLongValue
version for longs, uses two slots Only called from FeatureStructureImplC after determining there is no local field to use Is here because of 3 calls to things in this class- Parameters:
fsIn- the feature structurefeat- the feature to setv- -
-
setFeatureValueMaybeSofa
internal use - special setter for setting feature values, including special handling if the feature is for the sofaArray, when deserializing- Parameters:
fs- -feat- -value- -
-
setFeatureValueFromStringNoDocAnnotUpdate
public static void setFeatureValueFromStringNoDocAnnotUpdate(FeatureStructureImplC fs, FeatureImpl feat, String s) Internal use, for cases where deserializing - special case setting sofString to skip updating the document annotation- Parameters:
fs- -feat- -s- -
-
setFeatureValueFromString
Supports setting slots to "0" for null values- Parameters:
fs- The feature structure to updatefeat- the feature to update-s- the string representation of the value, could be null
-
int2float
public static final float int2float(int i) -
float2int
public static final int float2int(float f) -
long2double
public static final double long2double(long l) -
double2long
public static final long double2long(double d) -
isStringType
-
isAbstractArrayType
-
isArrayType
-
isPrimitiveArrayType
-
isIntArrayType
-
isFloatArrayType
-
isStringArrayType
-
isBooleanArrayType
-
isByteArrayType
-
isShortArrayType
-
isLongArrayType
-
isDoubleArrayType
-
isFSArrayType
-
isIntType
-
isFloatType
-
isByteType
-
isBooleanType
-
isShortType
-
isLongType
-
isDoubleType
-
initCASIndexes
Description copied from interface:CASMgrInstall the standard built-in indexes into the base CAS- Specified by:
initCASIndexesin interfaceCASMgr- Throws:
CASException- if an error occurs- See Also:
-
getView
-
getCurrentView
Description copied from interface:CASGet the Cas view that the current component should use. This should only be used by single-view components.- Specified by:
getCurrentViewin interfaceCAS- Returns:
- the Cas view specified for the current component by Sofa mapping. Defaults to _InitialView if there is no Sofa mapping.
-
getJCas
Description copied from interface:CASGet the JCas view for this CAS view -
getJCasImpl
Description copied from interface:CASGet the JCasImpl view for this CAS view- Specified by:
getJCasImplin interfaceCAS- Returns:
- the JCasImpl view for this CAS view
-
getJCas
Description copied from interface:CASCreate a JCas view for a Sofa. Note: as of UIMA v2.0, can be replaced with getView(sofaFS).getJCas().- Specified by:
getJCasin interfaceCAS- Parameters:
aSofa- a Sofa feature structure in this CAS.- Returns:
- The JCas view for the given Sofa.
- Throws:
CASException- -
-
getJCas
Deprecated.Description copied from interface:CASCreate a JCas view for a Sofa. Note: this is provided for convenience. It is equivalent togetView(aSofaID).getJCas().- Specified by:
getJCasin interfaceCAS- Parameters:
aSofaID- the ID of a Sofa defined in this CAS- Returns:
- The view for the Sofa with ID
aSofaID. - Throws:
CASException- if no Sofa with the given ID exists in this CAS
-
createView
Description copied from interface:CASCreate a view and its underlying Sofa (subject of analysis). The view provides access to the Sofa data and the index repository that contains metadata (annotations and other feature structures) pertaining to that Sofa.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)orCAS.setSofaDataURI(String, String)on the CAS view returned by this method.- Specified by:
createViewin interfaceCAS- Parameters:
aSofaID- the local name, before any sofa name mapping is done, for this view (note: this is the same as the associated Sofa name).- Returns:
- The view corresponding to this local name.
-
getView
Description copied from interface:CASGet the view for a Sofa (subject of analysis). The view provides access to the Sofa data and the index repository that contains metadata (annotations and other feature structures) pertaining to that Sofa. -
getView
Description copied from interface:CASGet the view for a Sofa (subject of analysis). The view provides access to the Sofa data and the index repository that contains metadata (annotations and other feature structures) pertaining to that Sofa. -
ll_getTypeSystem
Description copied from interface:LowLevelCASGet the low-level version of the type system object. It provides access to the low-level type and feature codes you need to use the data creation and access APIs.- Specified by:
ll_getTypeSystemin interfaceLowLevelCAS- Returns:
- The low-level type system.
-
ll_getIndexRepository
Description copied from interface:LowLevelCASGet the low-level version of the index repository. Use it to gain access to low-level indexes, and thus, low-level iterators.- Specified by:
ll_getIndexRepositoryin interfaceLowLevelCAS- Returns:
- A low-level version of the index repository.
-
checkTypingConditions
Check the range is appropriate for this type/feature. Throws LowLevelException if it isn't.- Parameters:
domType- domain typeranType- range typefeat- feature
-
getFsFromId_checked
-
ll_isRefType
public final boolean ll_isRefType(int typeCode) Description copied from interface:LowLevelCASChecks if the type code is that of a reference type (anything that's not a basic type, currently Integer, String and Float).- Specified by:
ll_isRefTypein interfaceLowLevelCAS- Parameters:
typeCode- The type code to check.- Returns:
trueifftypeCodeis the type code of a reference type.
-
ll_getTypeClass
public final int ll_getTypeClass(int typeCode) Description copied from interface:LowLevelCASDetermine the type class of a type. This is useful for generic CAS exploiters to determine what kind of data they're looking at. The type classes currently defined are: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.
- Specified by:
ll_getTypeClassin interfaceLowLevelCAS- Parameters:
typeCode- The type code.- Returns:
- A type class for the type code.
TYPE_CLASS_INVALIDif the type code argument does not represent a valid type code.
-
ll_createFS
public final int ll_createFS(int typeCode) Description copied from interface:LowLevelCASCreate a new FS on the heap.- Specified by:
ll_createFSin interfaceLowLevelCAS- Parameters:
typeCode- The low-level code of the type of the FS that should be created. If thetypeCodeis not a valid type code, the results of this call are undefined.- Returns:
- The reference of the newly created FS.
-
ll_createFS
public final int ll_createFS(int typeCode, boolean doCheck) Description copied from interface:LowLevelCASCreate a new FS on the heap.- Specified by:
ll_createFSin interfaceLowLevelCAS- Parameters:
typeCode- The low-level code of the type of the FS that should be created. If thetypeCodeis not a valid type code and the type check flag is not set, the results of this call are undefined.doCheck- -- Returns:
- The reference of the newly created FS.
-
ll_createArray
public int ll_createArray(int typeCode, int arrayLength) Description copied from interface:LowLevelCASCreate a new array.- Specified by:
ll_createArrayin interfaceLowLevelCAS- Parameters:
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.- Returns:
- The address of the newly created array.
-
createTempArray
public int createTempArray(int type, int len) (for backwards compatibility with V2 CASImpl) Create a temporary (i.e., per document) array FS on the heap.- Parameters:
type- The type code of the array to be created.len- The length of the array to be created.- Returns:
- -
- Throws:
ArrayIndexOutOfBoundsException- Iftypeis not a type.
-
ll_createByteArray
public int ll_createByteArray(int arrayLength) - Specified by:
ll_createByteArrayin interfaceLowLevelCAS- Parameters:
arrayLength- -- Returns:
- the id of the created array
-
ll_createBooleanArray
public int ll_createBooleanArray(int arrayLength) - Specified by:
ll_createBooleanArrayin interfaceLowLevelCAS- Parameters:
arrayLength- -- Returns:
- the id of the created array
-
ll_createShortArray
public int ll_createShortArray(int arrayLength) - Specified by:
ll_createShortArrayin interfaceLowLevelCAS- Parameters:
arrayLength- -- Returns:
- the id of the created array
-
ll_createLongArray
public int ll_createLongArray(int arrayLength) - Specified by:
ll_createLongArrayin interfaceLowLevelCAS- Parameters:
arrayLength- -- Returns:
- the id of the created array
-
ll_createDoubleArray
public int ll_createDoubleArray(int arrayLength) - Specified by:
ll_createDoubleArrayin interfaceLowLevelCAS- Parameters:
arrayLength- -- Returns:
- the id of the created array
-
ll_createArray
public int ll_createArray(int typeCode, int arrayLength, boolean doChecks) Description copied from interface:LowLevelCASCreate a new array.- Specified by:
ll_createArrayin interfaceLowLevelCAS- Parameters:
arrayLength- -typeCode- The type code of the array to be created.doChecks- Switch to turn on various sanity checks.- Returns:
- the id of the created array
-
validateArraySize
public void validateArraySize(int length) -
ll_getFSRef
Safety - any time the low level API to a FS is requested, hold on to that FS until CAS reset to mimic how v2 works.- Specified by:
ll_getFSRefin interfaceLowLevelCAS- Parameters:
fs- The FS object for which we want the reference.- Returns:
- The low-level reference of the FS object parameter.
-
ll_getFSForRef
Description copied from interface:LowLevelCASReturn a FS object that corresponds to a low-level reference. Note that this must be a valid reference that has been obtained from the low-level APIs. If the input reference parameter does not represent a valid reference, an exception is thrown.
In version 3, the map this API uses is not normally populated; it is populated only for Feature Structures created using the low-level APIs, and also when the ll_getFSRef API (above) is used, or the getAddress method is called on a Feature Structure
- Specified by:
ll_getFSForRefin interfaceLowLevelCAS- Type Parameters:
T- the Java class for the Feature Structure- Parameters:
id- The FS reference.- Returns:
- A FS object corresponding to the input reference.
-
ll_getIntValue
public final int ll_getIntValue(int fsRef, int featureCode) Handle some unusual backwards compatibility cases featureCode = 0 - implies getting the type code feature range is int - normal feature range is a fs reference, return the id feature range is a string: add the string if not already present to the string heap, return the int handle.- Specified by:
ll_getIntValuein interfaceLowLevelCAS- Parameters:
fsRef- -featureCode- -- Returns:
- -
-
ll_getFloatValue
public final float ll_getFloatValue(int fsRef, int featureCode) Description copied from interface:LowLevelCASGet the value of a float valued feature.- Specified by:
ll_getFloatValuein interfaceLowLevelCAS- Parameters:
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.- Returns:
- The value of the feature.
-
ll_getStringValue
Description copied from interface:LowLevelCASGet the value of a string valued feature.- Specified by:
ll_getStringValuein interfaceLowLevelCAS- Parameters:
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.- Returns:
- The value of the feature.
-
ll_getRefValue
public final int ll_getRefValue(int fsRef, int featureCode) Description copied from interface:LowLevelCASGet the value of a FS reference valued feature.- Specified by:
ll_getRefValuein interfaceLowLevelCAS- Parameters:
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.- Returns:
- The value of the feature.
-
ll_getIntValue
public final int ll_getIntValue(int fsRef, int featureCode, boolean doTypeChecks) Description copied from interface:LowLevelCASGet the value of an integer valued feature.- Specified by:
ll_getIntValuein interfaceLowLevelCAS- Parameters:
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.- Returns:
- The value of the feature.
-
ll_getFloatValue
public final float ll_getFloatValue(int fsRef, int featureCode, boolean doTypeChecks) Description copied from interface:LowLevelCASGet the value of a float valued feature.- Specified by:
ll_getFloatValuein interfaceLowLevelCAS- Parameters:
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.- Returns:
- The value of the feature.
-
ll_getStringValue
Description copied from interface:LowLevelCASGet the value of a string valued feature.- Specified by:
ll_getStringValuein interfaceLowLevelCAS- Parameters:
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.- Returns:
- The value of the feature.
-
ll_getRefValue
public final int ll_getRefValue(int fsRef, int featureCode, boolean doTypeChecks) Description copied from interface:LowLevelCASGet the value of a FS reference valued feature.- Specified by:
ll_getRefValuein interfaceLowLevelCAS- Parameters:
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.- Returns:
- The value of the feature.
-
maybeAddback
Only called if there was something removed that needs to be added back skip the addback (to defer it until later) if: - running in block mode (you can tell this if svd.fssTobeAddedback.size() > 0) or if running in block mode, the add back is delayed until the end of the block- Parameters:
fs- the fs to add back
-
ll_setIntValue
public final void ll_setIntValue(int fsRef, int featureCode, int value) Special considerations: Interface with corruption checking For backwards compatibility: handle cases where feature is: int - normal 0 - change type code a ref: treat int as FS "addr" not an int: handle like v2 where reasonable- Specified by:
ll_setIntValuein interfaceLowLevelCAS- Parameters:
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.
-
ll_setFloatValue
public final void ll_setFloatValue(int fsRef, int featureCode, float value) Description copied from interface:LowLevelCASSet the value of a float feature.- Specified by:
ll_setFloatValuein interfaceLowLevelCAS- Parameters:
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.
-
ll_setStringValue
Description copied from interface:LowLevelCASSet the value of a string feature.- Specified by:
ll_setStringValuein interfaceLowLevelCAS- Parameters:
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.
-
ll_setRefValue
public final void ll_setRefValue(int fsRef, int featureCode, int value) Description copied from interface:LowLevelCASSet the value of a FS reference feature.- Specified by:
ll_setRefValuein interfaceLowLevelCAS- Parameters:
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.
-
ll_setIntValue
public final void ll_setIntValue(int fsRef, int featureCode, int value, boolean doTypeChecks) Description copied from interface:LowLevelCASSet the value of an integer feature.- Specified by:
ll_setIntValuein interfaceLowLevelCAS- Parameters:
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.
-
ll_setFloatValue
public final void ll_setFloatValue(int fsRef, int featureCode, float value, boolean doTypeChecks) Description copied from interface:LowLevelCASSet the value of a float feature.- Specified by:
ll_setFloatValuein interfaceLowLevelCAS- Parameters:
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.
-
ll_setStringValue
Description copied from interface:LowLevelCASSet the value of a string feature.- Specified by:
ll_setStringValuein interfaceLowLevelCAS- Parameters:
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.
-
ll_setCharBufferValue
public final void ll_setCharBufferValue(int fsRef, int featureCode, char[] buffer, int start, int length, boolean doTypeChecks) - Specified by:
ll_setCharBufferValuein interfaceLowLevelCAS
-
ll_setCharBufferValue
public final void ll_setCharBufferValue(int fsRef, int featureCode, char[] buffer, int start, int length) - Specified by:
ll_setCharBufferValuein interfaceLowLevelCAS
-
ll_copyCharBufferValue
public int ll_copyCharBufferValue(int fsRef, int featureCode, char[] buffer, int start) - Specified by:
ll_copyCharBufferValuein interfaceLowLevelCAS
-
ll_getCharBufferValueSize
public int ll_getCharBufferValueSize(int fsRef, int featureCode) - Specified by:
ll_getCharBufferValueSizein interfaceLowLevelCAS
-
ll_setRefValue
public final void ll_setRefValue(int fsRef, int featureCode, int value, boolean doTypeChecks) Description copied from interface:LowLevelCASSet the value of a FS reference feature.- Specified by:
ll_setRefValuein interfaceLowLevelCAS- Parameters:
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.
-
getIntArrayValue
-
getFloatArrayValue
-
getStringArrayValue
-
getRefArrayValue
-
ll_getIntArrayValue
public final int ll_getIntArrayValue(int fsRef, int position) Description copied from interface:LowLevelCASGet the value of an array at a certain position.- Specified by:
ll_getIntArrayValuein interfaceLowLevelCAS- Parameters:
fsRef- The reference to the array FS.position- The position whose value should be returned.- Returns:
- The value at
position.
-
ll_getFloatArrayValue
public final float ll_getFloatArrayValue(int fsRef, int position) Description copied from interface:LowLevelCASGet the value of a float array at a certain position.- Specified by:
ll_getFloatArrayValuein interfaceLowLevelCAS- Parameters:
fsRef- The reference to the array FS.position- The position whose value should be returned.- Returns:
- The value at
position.
-
ll_getStringArrayValue
Description copied from interface:LowLevelCASGet the value of a string array at a certain position.- Specified by:
ll_getStringArrayValuein interfaceLowLevelCAS- Parameters:
fsRef- The reference to the array FS.position- The position whose value should be returned.- Returns:
- The value at
position.
-
ll_getRefArrayValue
public final int ll_getRefArrayValue(int fsRef, int position) Description copied from interface:LowLevelCASGet the value of a FS reference array at a certain position.- Specified by:
ll_getRefArrayValuein interfaceLowLevelCAS- Parameters:
fsRef- The reference to the array FS.position- The position whose value should be returned.- Returns:
- The value at
position.
-
checkArrayBounds
public final void checkArrayBounds(int fsRef, int pos) -
checkArrayBounds
public final void checkArrayBounds(int arrayLength, int pos, int length) -
ll_getIntArrayValue
public final int ll_getIntArrayValue(int fsRef, int position, boolean doTypeChecks) Description copied from interface:LowLevelCASGet the value of an integer array at a certain position.- Specified by:
ll_getIntArrayValuein interfaceLowLevelCAS- Parameters:
fsRef- The reference to the array FS.position- The position whose value should be returned.doTypeChecks- Switch to turn on type checking.- Returns:
- The value at
position.
-
ll_getFloatArrayValue
public float ll_getFloatArrayValue(int fsRef, int position, boolean doTypeChecks) Description copied from interface:LowLevelCASGet the value of a float array at a certain position.- Specified by:
ll_getFloatArrayValuein interfaceLowLevelCAS- Parameters:
fsRef- The reference to the array FS.position- The position whose value should be returned.doTypeChecks- Switch to turn on type checking.- Returns:
- The value at
position.
-
ll_getStringArrayValue
Description copied from interface:LowLevelCASGet the value of a string array at a certain position.- Specified by:
ll_getStringArrayValuein interfaceLowLevelCAS- Parameters:
fsRef- The reference to the array FS.position- The position whose value should be returned.doTypeChecks- Switch to turn on type checking.- Returns:
- The value at
position.
-
ll_getRefArrayValue
public int ll_getRefArrayValue(int fsRef, int position, boolean doTypeChecks) Description copied from interface:LowLevelCASGet the value of a FS reference array at a certain position.- Specified by:
ll_getRefArrayValuein interfaceLowLevelCAS- Parameters:
fsRef- The reference to the array FS.position- The position whose value should be returned.doTypeChecks- Switch to turn on type checking.- Returns:
- The value at
position.
-
ll_setIntArrayValue
public void ll_setIntArrayValue(int fsRef, int position, int value, boolean doTypeChecks) Description copied from interface:LowLevelCASSet the value of an integer array at a certain position.- Specified by:
ll_setIntArrayValuein interfaceLowLevelCAS- Parameters:
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.
-
ll_setFloatArrayValue
public void ll_setFloatArrayValue(int fsRef, int position, float value, boolean doTypeChecks) Description copied from interface:LowLevelCASSet the value of an integer array at a certain position.- Specified by:
ll_setFloatArrayValuein interfaceLowLevelCAS- Parameters:
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.
-
ll_setStringArrayValue
Description copied from interface:LowLevelCASSet the value of an integer array at a certain position.- Specified by:
ll_setStringArrayValuein interfaceLowLevelCAS- Parameters:
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.
-
ll_setRefArrayValue
public void ll_setRefArrayValue(int fsRef, int position, int value, boolean doTypeChecks) Description copied from interface:LowLevelCASSet the value of an integer array at a certain position.- Specified by:
ll_setRefArrayValuein interfaceLowLevelCAS- Parameters:
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.
-
ll_setIntArrayValue
public void ll_setIntArrayValue(int fsRef, int position, int value) Description copied from interface:LowLevelCASSet the value of an integer array at a certain position.- Specified by:
ll_setIntArrayValuein interfaceLowLevelCAS- Parameters:
fsRef- The FS reference of the array.position- The position whose value will be changed.value- The new value.
-
ll_setFloatArrayValue
public void ll_setFloatArrayValue(int fsRef, int position, float value) Description copied from interface:LowLevelCASSet the value of an integer array at a certain position.- Specified by:
ll_setFloatArrayValuein interfaceLowLevelCAS- Parameters:
fsRef- The FS reference of the array.position- The position whose value will be changed.value- The new value.
-
ll_setStringArrayValue
Description copied from interface:LowLevelCASSet the value of an integer array at a certain position.- Specified by:
ll_setStringArrayValuein interfaceLowLevelCAS- Parameters:
fsRef- The FS reference of the array.position- The position whose value will be changed.value- The new value.
-
ll_setRefArrayValue
public void ll_setRefArrayValue(int fsRef, int position, int value) Description copied from interface:LowLevelCASSet the value of an integer array at a certain position.- Specified by:
ll_setRefArrayValuein interfaceLowLevelCAS- Parameters:
fsRef- The FS reference of the array.position- The position whose value will be changed.value- The new value.
-
ll_getFSRefType
public int ll_getFSRefType(int fsRef) Description copied from interface:LowLevelCASGet the type code for a FS reference. No bounds checks are performed. IffsRefis 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.- Specified by:
ll_getFSRefTypein interfaceLowLevelCAS- Parameters:
fsRef- an id for a FS- Returns:
- the type code for this FS
-
ll_getFSRefType
public int ll_getFSRefType(int fsRef, boolean doChecks) Description copied from interface:LowLevelCASGet the type code for a FS reference.- Specified by:
ll_getFSRefTypein interfaceLowLevelCAS- Parameters:
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.- Returns:
- The type code for the FS reference; a return value of
0means that the fsRef is invalid, i.e.,NULL_FS_REF(but see remarks on bounds checking for this method).
-
getLowLevelCAS
Description copied from interface:CASGet an instance of the low-level CAS. Low-level and regular CAS can be used in parallel, all data is always contained in both.Note: This is for internal use.
- Specified by:
getLowLevelCASin interfaceCAS- Returns:
- A low-level CAS.
- See Also:
-
size
public int size()Description copied from interface:CASEstimate the memory consumption of this CAS instance (in bytes). -
getJCasClassLoader
Description copied from interface:CASMgrGets the ClassLoader that should be used by the JCas to load the generated FS cover classes for this CAS.- Specified by:
getJCasClassLoaderin interfaceCASMgr- Returns:
- the JCas ClassLoder for this CAS
-
setJCasClassLoader
Description copied from interface:CASMgrSets the ClassLoader that should be used by the JCas to load the generated FS cover classes for this CAS.- Specified by:
setJCasClassLoaderin interfaceCASMgr- Parameters:
classLoader- the JCas ClassLoder for this CAS
-
switchClassLoader
-
switchClassLoaderLockCas
-
switchClassLoaderLockCasCL
-
restoreClassLoaderUnlockCas
public void restoreClassLoaderUnlockCas() -
createFeatureValuePath
Description copied from interface:CASCreate a feature-value path from a string.- Specified by:
createFeatureValuePathin interfaceCAS- Parameters:
featureValuePath- String representation of the feature-value path.- Returns:
- Feature-value path object.
- Throws:
CASRuntimeException- If the input string is not well-formed.
-
setOwner
Description copied from class:AbstractCas_ImplBaseProvides this CAS with a handle to the CASOwner that owns it. This is called by the framework when a CAS instance is created. This handle is used to implement the release() method by returning the CAS to its CasOwner.- Overrides:
setOwnerin classAbstractCas_ImplBase- Parameters:
aCasOwner- -
-
release
public void release()Description copied from class:AbstractCas_ImplBaseDefault implementation that returns this CAS to its CasManager by callingCasOwner.releaseCas(AbstractCas).- Specified by:
releasein interfaceAbstractCas- Overrides:
releasein classAbstractCas_ImplBase
-
createByteArrayFS
Description copied from interface:CASCreate a new Byte array.- Specified by:
createByteArrayFSin interfaceCAS- Parameters:
length- The length of the array.- Returns:
- The new array.
- Throws:
CASRuntimeException
-
createBooleanArrayFS
Description copied from interface:CASCreate a new Boolean array.- Specified by:
createBooleanArrayFSin interfaceCAS- Parameters:
length- The length of the array.- Returns:
- The new array.
- Throws:
CASRuntimeException
-
createShortArrayFS
Description copied from interface:CASCreate a new Short array.- Specified by:
createShortArrayFSin interfaceCAS- Parameters:
length- The length of the array.- Returns:
- The new array.
- Throws:
CASRuntimeException
-
createLongArrayFS
Description copied from interface:CASCreate a new Long array.- Specified by:
createLongArrayFSin interfaceCAS- Parameters:
length- The length of the array.- Returns:
- The new array.
- Throws:
CASRuntimeException
-
createDoubleArrayFS
Description copied from interface:CASCreate a new Double array.- Specified by:
createDoubleArrayFSin interfaceCAS- Parameters:
length- The length of the array.- Returns:
- The new array.
- Throws:
CASRuntimeException
-
ll_getByteValue
public byte ll_getByteValue(int fsRef, int featureCode) - Specified by:
ll_getByteValuein interfaceLowLevelCAS
-
ll_getByteValue
public byte ll_getByteValue(int fsRef, int featureCode, boolean doTypeChecks) - Specified by:
ll_getByteValuein interfaceLowLevelCAS
-
ll_getBooleanValue
public boolean ll_getBooleanValue(int fsRef, int featureCode) - Specified by:
ll_getBooleanValuein interfaceLowLevelCAS
-
ll_getBooleanValue
public boolean ll_getBooleanValue(int fsRef, int featureCode, boolean doTypeChecks) - Specified by:
ll_getBooleanValuein interfaceLowLevelCAS
-
ll_getShortValue
public short ll_getShortValue(int fsRef, int featureCode) - Specified by:
ll_getShortValuein interfaceLowLevelCAS
-
ll_getShortValue
public short ll_getShortValue(int fsRef, int featureCode, boolean doTypeChecks) - Specified by:
ll_getShortValuein interfaceLowLevelCAS
-
ll_getLongValue
public long ll_getLongValue(int fsRef, int featureCode) - Specified by:
ll_getLongValuein interfaceLowLevelCAS
-
ll_getLongValue
public long ll_getLongValue(int fsRef, int featureCode, boolean doTypeChecks) - Specified by:
ll_getLongValuein interfaceLowLevelCAS
-
ll_getDoubleValue
public double ll_getDoubleValue(int fsRef, int featureCode) - Specified by:
ll_getDoubleValuein interfaceLowLevelCAS
-
ll_getDoubleValue
public double ll_getDoubleValue(int fsRef, int featureCode, boolean doTypeChecks) - Specified by:
ll_getDoubleValuein interfaceLowLevelCAS
-
ll_setBooleanValue
public void ll_setBooleanValue(int fsRef, int featureCode, boolean value) - Specified by:
ll_setBooleanValuein interfaceLowLevelCAS
-
ll_setBooleanValue
public void ll_setBooleanValue(int fsRef, int featureCode, boolean value, boolean doTypeChecks) - Specified by:
ll_setBooleanValuein interfaceLowLevelCAS
-
ll_setByteValue
public final void ll_setByteValue(int fsRef, int featureCode, byte value) - Specified by:
ll_setByteValuein interfaceLowLevelCAS
-
ll_setByteValue
public void ll_setByteValue(int fsRef, int featureCode, byte value, boolean doTypeChecks) - Specified by:
ll_setByteValuein interfaceLowLevelCAS
-
ll_setShortValue
public final void ll_setShortValue(int fsRef, int featureCode, short value) - Specified by:
ll_setShortValuein interfaceLowLevelCAS
-
ll_setShortValue
public void ll_setShortValue(int fsRef, int featureCode, short value, boolean doTypeChecks) - Specified by:
ll_setShortValuein interfaceLowLevelCAS
-
ll_setLongValue
public void ll_setLongValue(int fsRef, int featureCode, long value) - Specified by:
ll_setLongValuein interfaceLowLevelCAS
-
ll_setLongValue
public void ll_setLongValue(int fsRef, int featureCode, long value, boolean doTypeChecks) - Specified by:
ll_setLongValuein interfaceLowLevelCAS
-
ll_setDoubleValue
public void ll_setDoubleValue(int fsRef, int featureCode, double value) - Specified by:
ll_setDoubleValuein interfaceLowLevelCAS
-
ll_setDoubleValue
public void ll_setDoubleValue(int fsRef, int featureCode, double value, boolean doTypeChecks) - Specified by:
ll_setDoubleValuein interfaceLowLevelCAS
-
ll_getByteArrayValue
public byte ll_getByteArrayValue(int fsRef, int position) - Specified by:
ll_getByteArrayValuein interfaceLowLevelCAS
-
ll_getByteArrayValue
public byte ll_getByteArrayValue(int fsRef, int position, boolean doTypeChecks) - Specified by:
ll_getByteArrayValuein interfaceLowLevelCAS
-
ll_getBooleanArrayValue
public boolean ll_getBooleanArrayValue(int fsRef, int position) - Specified by:
ll_getBooleanArrayValuein interfaceLowLevelCAS
-
ll_getBooleanArrayValue
public boolean ll_getBooleanArrayValue(int fsRef, int position, boolean doTypeChecks) - Specified by:
ll_getBooleanArrayValuein interfaceLowLevelCAS
-
ll_getShortArrayValue
public short ll_getShortArrayValue(int fsRef, int position) - Specified by:
ll_getShortArrayValuein interfaceLowLevelCAS
-
ll_getShortArrayValue
public short ll_getShortArrayValue(int fsRef, int position, boolean doTypeChecks) - Specified by:
ll_getShortArrayValuein interfaceLowLevelCAS
-
ll_getLongArrayValue
public long ll_getLongArrayValue(int fsRef, int position) - Specified by:
ll_getLongArrayValuein interfaceLowLevelCAS
-
ll_getLongArrayValue
public long ll_getLongArrayValue(int fsRef, int position, boolean doTypeChecks) - Specified by:
ll_getLongArrayValuein interfaceLowLevelCAS
-
ll_getDoubleArrayValue
public double ll_getDoubleArrayValue(int fsRef, int position) - Specified by:
ll_getDoubleArrayValuein interfaceLowLevelCAS
-
ll_getDoubleArrayValue
public double ll_getDoubleArrayValue(int fsRef, int position, boolean doTypeChecks) - Specified by:
ll_getDoubleArrayValuein interfaceLowLevelCAS
-
ll_setByteArrayValue
public void ll_setByteArrayValue(int fsRef, int position, byte value) - Specified by:
ll_setByteArrayValuein interfaceLowLevelCAS
-
ll_setByteArrayValue
public void ll_setByteArrayValue(int fsRef, int position, byte value, boolean doTypeChecks) - Specified by:
ll_setByteArrayValuein interfaceLowLevelCAS
-
ll_setBooleanArrayValue
public void ll_setBooleanArrayValue(int fsRef, int position, boolean b) - Specified by:
ll_setBooleanArrayValuein interfaceLowLevelCAS
-
ll_setBooleanArrayValue
public void ll_setBooleanArrayValue(int fsRef, int position, boolean value, boolean doTypeChecks) - Specified by:
ll_setBooleanArrayValuein interfaceLowLevelCAS
-
ll_setShortArrayValue
public void ll_setShortArrayValue(int fsRef, int position, short value) - Specified by:
ll_setShortArrayValuein interfaceLowLevelCAS
-
ll_setShortArrayValue
public void ll_setShortArrayValue(int fsRef, int position, short value, boolean doTypeChecks) - Specified by:
ll_setShortArrayValuein interfaceLowLevelCAS
-
ll_setLongArrayValue
public void ll_setLongArrayValue(int fsRef, int position, long value) - Specified by:
ll_setLongArrayValuein interfaceLowLevelCAS
-
ll_setLongArrayValue
public void ll_setLongArrayValue(int fsRef, int position, long value, boolean doTypeChecks) - Specified by:
ll_setLongArrayValuein interfaceLowLevelCAS
-
ll_setDoubleArrayValue
public void ll_setDoubleArrayValue(int fsRef, int position, double d) - Specified by:
ll_setDoubleArrayValuein interfaceLowLevelCAS
-
ll_setDoubleArrayValue
public void ll_setDoubleArrayValue(int fsRef, int position, double value, boolean doTypeChecks) - Specified by:
ll_setDoubleArrayValuein interfaceLowLevelCAS
-
isAnnotationType
-
isSubtypeOfAnnotationBaseType
public boolean isSubtypeOfAnnotationBaseType(int t) - Parameters:
t- the type code to test- Returns:
- true if that type is subsumed by AnnotationBase type
-
isBaseCas
public boolean isBaseCas() -
createAnnotation
Description copied from interface:CASCreate a new annotation. Note that you still need to insert the annotation into the index repository yourself.- Specified by:
createAnnotationin interfaceCAS- Parameters:
type- The type of the annotation.begin- The start of the annotation.end- The end of the annotation.- Returns:
- A new annotation object.
-
ll_createAnnotation
public int ll_createAnnotation(int typeCode, int begin, int end) -
getAnnotationIndex
The generic spec T extends AnnotationFS (rather than AnnotationFS) allows the method JCasImpl getAnnotationIndex to return Annotation instead of AnnotationFS- Specified by:
getAnnotationIndexin interfaceCAS- Type Parameters:
T- the Java class associated with the annotation index- Returns:
- the annotation index
-
getAnnotationIndex
public <T extends AnnotationFS> AnnotationIndex<T> getAnnotationIndex(Type type) throws CASRuntimeException Description copied from interface:CASGet the standard annotation index restricted to a specific annotation type.- Specified by:
getAnnotationIndexin interfaceCAS- Type Parameters:
T- the topmost Java class corresponding to the type- Parameters:
type- The annotation type the index is restricted to.- Returns:
- The standard annotation index, restricted to
type. - Throws:
CASRuntimeException- Whentypeis not an annotation type.
-
getAnnotationType
Description copied from interface:CASGet the type object for the annotation type.- Specified by:
getAnnotationTypein interfaceCAS- Returns:
- The annotation type.
- See Also:
-
getEndFeature
Description copied from interface:CASGet the feature object for the annotation end feature.- Specified by:
getEndFeaturein interfaceCAS- Returns:
- The annotation end feature.
- See Also:
-
getBeginFeature
Description copied from interface:CASGet the feature object for the annotation begin feature.- Specified by:
getBeginFeaturein interfaceCAS- Returns:
- The annotation begin feature.
- See Also:
-
createDocumentAnnotationNoRemoveNoIndex
-
ll_createDocumentAnnotation
public int ll_createDocumentAnnotation(int length) -
ll_createDocumentAnnotationNoIndex
public int ll_createDocumentAnnotationNoIndex(int begin, int end) -
updateDocumentAnnotation
public void updateDocumentAnnotation()updates the document annotation (only if the sofa's local string data != null) setting the end feature to be the length of the sofa string, if any. creates the document annotation if not present only works if not in the base cas -
getDocumentAnnotation
Generic issue: The returned document annotation could be either an instance of DocumentAnnotation or a subclass of it, or an instance of Annotation - the Java cover class used for annotations when JCas is not being used.- Specified by:
getDocumentAnnotationin interfaceCAS- Type Parameters:
T- the Java class for the document annotation. Could be the JCas cover class or FeatureStructure- Returns:
- The document annotation. If it doesn't exist, one is created. The return value is the JCas cover class or the plain Java cover class for FeatureStructures if there is no JCas cover class for this type.
-
getDocumentAnnotationNoCreate
-
ll_getDocumentAnnotation
public int ll_getDocumentAnnotation()- Returns:
- the fs addr of the document annotation found via the index, or 0 if not there
-
getDocumentLanguage
Description copied from interface:CASGets the language code for this document from the language feature of the special instance of the DocumentationAnnotation associated with this CAS.- Specified by:
getDocumentLanguagein interfaceCAS- Returns:
- language identifier
-
getDocumentText
Description copied from interface:CASGet the document text.- Specified by:
getDocumentTextin interfaceCAS- Returns:
- The text being analyzed, or
nullif not set.
-
getSofaDataString
Description copied from interface:CASGet the Sofa Data String (a.k.a. the document text).- Specified by:
getSofaDataStringin interfaceCAS- Returns:
- The Sofa data string, or
nullif not set.
-
getSofaDataArray
Description copied from interface:CASGet the Sofa data array.- Specified by:
getSofaDataArrayin interfaceCAS- Returns:
- The Sofa Data being analyzed, or
nullif not set.
-
getSofaDataURI
Description copied from interface:CASGet the Sofa data array.- Specified by:
getSofaDataURIin interfaceCAS- Returns:
- The Sofa URI being analyzed, or
nullif not set.
-
getSofaDataStream
Description copied from interface:CASGet the Sofa data as a byte stream.- Specified by:
getSofaDataStreamin interfaceCAS- Returns:
- A stream handle to the Sofa Data, or
nullif not set.
-
getSofaMimeType
Description copied from interface:CASGet the mime type of the Sofa data being analyzed.- Specified by:
getSofaMimeTypein interfaceCAS- Returns:
- the mime type of the Sofa
-
getSofa
Description copied from interface:CASGet the Sofa feature structure associated with this CAS view. -
ll_getSofa
public int ll_getSofa()- Specified by:
ll_getSofain interfaceLowLevelCAS- Returns:
- the addr of the sofaFS associated with this view, or 0
-
getViewName
Description copied from interface:CASGet the view name. The view name is the same as the name of the view's Sofa, retrieved by getSofa().getSofaID(), except for the initial View before its Sofa has been created.- Specified by:
getViewNamein interfaceCAS- Returns:
- The name of the view
-
setDocumentLanguage
Description copied from interface:CASSets the language for this document. This value sets the language feature of the special instance of DocumentAnnotation associated with this CAS.- Specified by:
setDocumentLanguagein interfaceCAS- Parameters:
languageCode- -
-
setDocumentText
Description copied from interface:CASSet the document text. Once set, Sofa data is immutable, and cannot be set again until the CAS has been reset.- Specified by:
setDocumentTextin interfaceCAS- Parameters:
text- The text to be analyzed.
-
setSofaDataString
Description copied from interface:CASSet the document text. Once set, Sofa data is immutable, and cannot be set again until the CAS has been reset.- Specified by:
setSofaDataStringin interfaceCAS- Parameters:
text- The text to be analyzed.mime- The mime type of the data- Throws:
CASRuntimeException- If the Sofa data has already been set.
-
setSofaDataArray
Description copied from interface:CASSet the Sofa data as an ArrayFS. Once set, Sofa data is immutable, and cannot be set again until the CAS has been reset.- Specified by:
setSofaDataArrayin interfaceCAS- Parameters:
array- The ArrayFS to be analyzed.mime- The mime type of the data
-
setSofaDataURI
Description copied from interface:CASSet the Sofa data as a URI. Once set, Sofa data is immutable, and cannot be set again until the CAS has been reset.- Specified by:
setSofaDataURIin interfaceCAS- Parameters:
uri- The URI of the data to be analyzed.mime- The mime type of the data- Throws:
CASRuntimeException- If the Sofa data has already been set.
-
setCurrentComponentInfo
Description copied from interface:CASInforms the CAS of relevant information about the component that is currently processing it. This is called by the framework automatically; users do not need to call it.- Specified by:
setCurrentComponentInfoin interfaceCAS- Parameters:
info- information about the component that is currently processing this CAS.
-
addFsToIndexes
Description copied from interface:CASAdd a feature structure to all appropriate indexes in the repository associated with this CAS View. If no indexes exist for the type of FS that you are adding, then a bag (unsorted) index will be automatically created.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 callremoveFsFromIndexes(...)on the FS, change the feature values, then calladdFsToIndexes(...)again.- Specified by:
addFsToIndexesin interfaceCAS- Parameters:
fs- The Feature Structure to be added.- See Also:
-
removeFsFromIndexes
Description copied from interface:CASRemove a feature structure from all indexes in the repository associated with this CAS View. The remove operation removes the exact fs from the indexes, unlike operations such as moveTo which use the fs argument as a template. It is not an error if the FS is not present in the indexes.- Specified by:
removeFsFromIndexesin interfaceCAS- Parameters:
fs- The Feature Structure to be removed.- See Also:
-
getSofaCasView
- Parameters:
fs- the AnnotationBase instance- Returns:
- the view associated with this FS where it could be indexed
-
ll_getSofaCasView
- Specified by:
ll_getSofaCasViewin interfaceLowLevelCAS
-
getNumberOfViews
public int getNumberOfViews()Creates the initial view (without a sofa) if not present- Returns:
- the number of views, excluding the base view, including the initial view (even if not initially present or no sofa)
-
getNumberOfSofas
public int getNumberOfSofas() -
getViewIterator
Description copied from interface:CASGet iterator over all views in this CAS. Each view provides access to Sofa data and the index repository that contains metadata (annotations and other feature structures) pertaining to that Sofa.- Specified by:
getViewIteratorin interfaceCAS- Type Parameters:
T- generic type of returned view- Returns:
- an iterator which returns all views. Each object returned by the iterator is of type CAS or a subtype.
-
getViewImplIterator
excludes initial view if its sofa is not valid- Returns:
- iterator over all views except the base view
-
forAllViews
iterate over all views in view order (by view number)- Parameters:
processViews- action to perform on the views.
-
getViewIterator
Description copied from interface:CASGet iterator over all views with the given name prefix. Each view provides access to Sofa data and the index repository that contains metadata (annotations and other feature structures) pertaining to that Sofa.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.- Specified by:
getViewIteratorin interfaceCAS- Parameters:
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).- Returns:
- an iterator which returns all views with the given name prefix. Each object returned by the iterator is of type CAS.
-
protectIndexes
protectIndexes Within the scope of protectIndexes, feature updates are checked, and if found to be a key, and the FS is in a corruptible 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. Later, when the protectIndexes is closed, the tobe items are added back to the indexes.- Specified by:
protectIndexesin interfaceCAS- Returns:
- an object used to record things that need adding back
-
protectIndexes
Description copied from interface:CASRuns 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. At the end of the block, affected indexes have any removed-under-the-covers FSs added back.- Specified by:
protectIndexesin interfaceCAS- Parameters:
r- an inner block of code to be run with
-
createMarker
The current implementation only supports 1 marker call per CAS. Subsequent calls will throw an error. The design is intended to support (at some future point) multiple markers; for this to work, the intent is to extend the MarkerImpl to keep track of indexes into these IntVectors specifying where that marker starts/ends.- Specified by:
createMarkerin interfaceCAS- Returns:
- a marker object.
-
getCurrentMark
-
toString
-
getCasResets
public int getCasResets() -
getCasId
- Returns:
- an identifier for this CAS, globally unique within the classloader
-
getNextFsId
-
adjustLastFsV2Size_arrays
public void adjustLastFsV2Size_arrays(int arrayLength) -
adjustLastFsV2size_nonHeapStoredArrays
public void adjustLastFsV2size_nonHeapStoredArrays() -
setId2FSsMaybeUnconditionally
Test case use- Parameters:
fss- the FSs to include in the id 2 fs map
-
getLastUsedFsId
public final int getLastUsedFsId() -
peekNextFsId
public final int peekNextFsId() -
lastV2IdIncr
public final int lastV2IdIncr() -
captureLastFsIdForOtherThread
public final void captureLastFsIdForOtherThread()Call this to capture the current value of fsIdGenerator and make it available to other threads. Must be called on a thread that has been synchronized with the thread used for creating FSs for this CAS. -
getFsFromId
-
walkReachablePlusFSsSorted
public List<TOP> walkReachablePlusFSsSorted(Consumer<TOP> action_filtered, MarkerImpl mark, Predicate<TOP> includeFilter, CasTypeSystemMapper typeMapper) find all of the FSs via the indexes plus what's reachable. sort into order by id, Apply the action to those Return the list of sorted FSs- Parameters:
action_filtered- action to perform on each item after filteringmark- null or the markincludeFilter- null or a filter (exclude items not in other type system)typeMapper- null or how to map to other type system, used to skip things missing in other type system- Returns:
- sorted list of all found items (ignoring mark)
-
isSameCAS
-
isInCAS
-
checkArrayPreconditions
- Throws:
CASRuntimeException
-
emptyFSList
- Specified by:
emptyFSListin interfaceCAS- Type Parameters:
T- the type of the elements of the FSList- Returns:
- a lazily created shared (for this CAS) empty list
-
emptyFloatList
- Specified by:
emptyFloatListin interfaceCAS- Returns:
- a lazily created shared (for this CAS) empty list
-
emptyIntegerList
- Specified by:
emptyIntegerListin interfaceCAS- Returns:
- a lazily created shared (for this CAS) empty list
-
emptyStringList
- Specified by:
emptyStringListin interfaceCAS- Returns:
- a lazily created shared (for this CAS) empty list
-
emptyArray
-
emptyFloatArray
- Specified by:
emptyFloatArrayin interfaceCAS- Returns:
- a lazily created shared (for this CAS) 0-length array
-
emptyFSArray
- Specified by:
emptyFSArrayin interfaceCAS- Type Parameters:
T- the type of the elements of the FSArray- Returns:
- a lazily created shared (for this CAS) 0-length FSarray
-
emptyFSArray
- Specified by:
emptyFSArrayin interfaceCAS- Type Parameters:
T- the type of the elements of the FSArray- Parameters:
type- the type of the elements of the FSArray- Returns:
- a lazily created shared (for this CAS) 0-length subtype of FSarray holding elements of type element-type
-
emptyIntegerArray
- Specified by:
emptyIntegerArrayin interfaceCAS- Returns:
- a lazily created shared (for this CAS) 0-length array
-
emptyStringArray
- Specified by:
emptyStringArrayin interfaceCAS- Returns:
- a lazily created shared (for this CAS) 0-length array
-
emptyDoubleArray
- Specified by:
emptyDoubleArrayin interfaceCAS- Returns:
- a lazily created shared (for this CAS) 0-length array
-
emptyLongArray
- Specified by:
emptyLongArrayin interfaceCAS- Returns:
- a lazily created shared (for this CAS) 0-length array
-
emptyShortArray
- Specified by:
emptyShortArrayin interfaceCAS- Returns:
- a lazily created shared (for this CAS) 0-length array
-
emptyByteArray
- Specified by:
emptyByteArrayin interfaceCAS- Returns:
- a lazily created shared (for this CAS) 0-length array
-
emptyBooleanArray
- Specified by:
emptyBooleanArrayin interfaceCAS- Returns:
- a lazily created shared (for this CAS) 0-length array
-
emptyList
- Parameters:
rangeCode- special codes for serialization use only- Returns:
- the empty list (shared) corresponding to the type
-
emptyListFromTypeCode
Get an empty list from the type code of a list- Parameters:
typeCode- -- Returns:
- -
-
copyFeatureExceptFsRef
public static boolean copyFeatureExceptFsRef(TOP fsSrc, FeatureImpl fiSrc, TOP fsTgt, FeatureImpl fiTgt) Copies a feature from one fs to another FSs may be in different type systems Doesn't copy a feature ref, but instead returns false. This is because feature refs can't cross CASes- Parameters:
fsSrc- source FSfiSrc- feature in source to copyfsTgt- target FSfiTgt- feature in target to set- Returns:
- false if feature is an fsRef
-
copyArray
-
getBinaryCasSerDes
-
deltaMergesComplete
public void deltaMergesComplete()A space-freeing optimization for use cases where (multiple) delta CASes are being deserialized into this CAS and merged. -
traceFSCreate
-
traceFSflush
-
setCAS
Deprecated.Description copied from interface:CASMgrDoes nothing, kept only for backwards compatibility -
getInitialHeapSize
public int getInitialHeapSize()- Returns:
- the initial heap size specified or defaulted
-
reinit
Deserializer for Java-object serialized instance of CASSerializer.- Parameters:
ser- - The instance to convert back to a CAS
-
reinit
Deserializer for CASCompleteSerializer instances - includes type system and index definitions Never delta- Parameters:
casCompSer- -
-
reinit
--------------------------------------------------------------------- see Blob Format in CASSerializer This reads in and deserializes CAS data from a stream. Byte swapping may be needed if the blob is from C++ -- C++ blob serialization writes data in native byte order. Supports delta deserialization. For that, the the csds from the serialization event must be used.- Parameters:
istream- -- Returns:
- - the format of the input stream detected
- Throws:
CASRuntimeException- wraps IOException
-
swapInPearVersion
-
collectNonPearVersions
-
makePearAware
-
is_ll_enableV2IdRefs
public boolean is_ll_enableV2IdRefs()- Specified by:
is_ll_enableV2IdRefsin interfaceLowLevelCAS- Returns:
- true if the id_to_fs_map mode is enabled
-
ll_enableV2IdRefs
Description copied from interface:LowLevelCASEnables or disables the id_to_fs_map mode.- Specified by:
ll_enableV2IdRefsin interfaceLowLevelCAS- Parameters:
enable- true to enable, false to disable- Returns:
- an AutoClosable whose close method doesn't throw an exception that will reset the mode to what it was when it was changed
-
set_deserialized_doc_annot_not_indexed
-
reset()instead.