---

             

---

cas.hpp File Reference

---

Detailed Description

. Contains class uima::CAS

-----------------------------------------------------------------------------

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

-----------------------------------------------------------------------------

Description: The CAS object provides access to the type system, to indexes, iterators and filters (constraints). It also lets you create new annotations, Sofas and other data structures.

Use uima::AnalysisEngine::newCAS() to instantiate a CAS

-----------------------------------------------------------------------------

--------------------------------------------------------------------------

Namespaces
namespace	uima
namespace	uima::lowlevel
namespace	uima::internal
Classes
class	uima::CAS
	The CAS (Common Analysis System) is the container where all feature structures are stored and maintained. More...
class	uima::SofaFS
	The Sofa is implemented as a feature structure of type uima.cas.Sofa. More...
class	uima::AnnotationFS
	Class AnnotationFS derives from a standard FeatureStrucure and extends with convenience functions specific for feature structures of type annotation. More...
class	uima::ANIterator
	Iterator over AnnotationFS objects in a CAS annotation index (ANIndex). More...
class	uima::ANIndex
	This class represents a single index over feature structures of type annotation. More...
class	uima::DocumentFS
	Class DocumentFS derives from AnnotationFS and extends with convenience functions specific for the single feature structures of type Document-Annotation that is present for each input document. More...
Defines
#define	UIMA_ENGINE_CONFIG_OPTION_PREDEF_TYPES   _TEXT("PredefinedTypes")
#define	UIMA_ENGINE_CONFIG_OPTION_FSHEAP_PAGESIZE   _TEXT("FSHeapPageSize")
#define	UIMA_ENGINE_CONFIG_OPTION_STRINGHEAP_PAGESIZE   _TEXT("StringHeapPageSize")
#define	UIMA_ENGINE_CONFIG_OPTION_STRINGREFHEAP_PAGESIZE   _TEXT("StringRefHeapPageSize")
Typedefs
typedef enum uima::EnIteratorAmbiguity_	EnIteratorAmbiguity
	This enum is used for annotation iterators to determine there iteration behaviour.
Enumerations
enum	EnIteratorAmbiguity_ { enAmbiguous, enUnambiguous, enNumberOfIteratorAmbiguityElems }
	This enum is used for annotation iterators to determine there iteration behaviour. More...
Functions
void	fromHeapCellTempl (lowlevel::TyHeapCell, uima::CAS &, FeatureStructure &)
	UIMA_EXC_CLASSDECLARE (CouldNotCreateFSOfFinalTypeException, CASException)
	UIMA_EXC_CLASSDECLARE (DuplicateSofaNameException, CASException)
	UIMA_EXC_CLASSDECLARE (InvalidBaseCasMethod, CASException)
Variables
const size_t	UIMA_ENGINE_CONFIG_DEFAULT_FSHEAP_PAGESIZE = 10000
const size_t	UIMA_ENGINE_CONFIG_DEFAULT_STRINGHEAP_PAGESIZE = UIMA_ENGINE_CONFIG_DEFAULT_FSHEAP_PAGESIZE
const size_t	UIMA_ENGINE_CONFIG_DEFAULT_STRINGREFHEAP_PAGESIZE = UIMA_ENGINE_CONFIG_DEFAULT_STRINGHEAP_PAGESIZE

---

Define Documentation

#define UIMA_ENGINE_CONFIG_OPTION_PREDEF_TYPES   _TEXT("PredefinedTypes")

#define UIMA_ENGINE_CONFIG_OPTION_FSHEAP_PAGESIZE   _TEXT("FSHeapPageSize")

#define UIMA_ENGINE_CONFIG_OPTION_STRINGHEAP_PAGESIZE   _TEXT("StringHeapPageSize")

#define UIMA_ENGINE_CONFIG_OPTION_STRINGREFHEAP_PAGESIZE   _TEXT("StringRefHeapPageSize")

---

Typedef Documentation

typedef enum uima::EnIteratorAmbiguity_ uima::EnIteratorAmbiguity

This enum is used for annotation iterators to determine there iteration behaviour. This is used in ANIndex::subIterator(), AnnotationFS::subIterator() and ANIterator::subIterator() See also: ANIndex ANIterator AnnotationFS

---

Enumeration Type Documentation

enum EnIteratorAmbiguity_

This enum is used for annotation iterators to determine there iteration behaviour. This is used in ANIndex::subIterator(), AnnotationFS::subIterator() and ANIterator::subIterator() See also: ANIndex ANIterator AnnotationFS Enumeration values: enAmbiguous  enUnambiguous  Default behaviour: return all annotations, even if several are available for a postion. enNumberOfIteratorAmbiguityElems  return only one annotation for a given position.

---

Function Documentation

void fromHeapCellTempl (  lowlevel::TyHeapCell  , uima::CAS &  , FeatureStructure &  )

UIMA_EXC_CLASSDECLARE (  CouldNotCreateFSOfFinalTypeException  , CASException  )

UIMA_EXC_CLASSDECLARE (  DuplicateSofaNameException  , CASException  )

UIMA_EXC_CLASSDECLARE (  InvalidBaseCasMethod  , CASException  )

---

Variable Documentation

const size_t UIMA_ENGINE_CONFIG_DEFAULT_FSHEAP_PAGESIZE = 10000

const size_t UIMA_ENGINE_CONFIG_DEFAULT_STRINGHEAP_PAGESIZE = UIMA_ENGINE_CONFIG_DEFAULT_FSHEAP_PAGESIZE

const size_t UIMA_ENGINE_CONFIG_DEFAULT_STRINGREFHEAP_PAGESIZE = UIMA_ENGINE_CONFIG_DEFAULT_STRINGHEAP_PAGESIZE

---