This file contains some useful CASWriters, one is used in the dump annotator, the other one can be used to output the CAS in XCAS format.
The XCASDeserializer deserializes cas data in XCAS format into a CAS.
Importing and Exporting global objects, such as variables and functions.
include "uima/annotator_file.hpp"
The only exception to this are defines which due to restrictions of the C++ language can not be put in namespaces (to make up for the missing namespace all defines are prefixed with UIMA
)
the type uima::TyHandle is used as a handle to a resource the type uima::ComponentId is used in trace msgs
Only FeatureStructures with types that are represented in the input CAS TypeSystem will be deserialized into the CAS. At this time support for out of typesystem data is not supported.
Classes | |
class | Annotator |
The class Annotator defines the API methods an annotator must implement. More... | |
class | TextAnnotator |
class | AnnotatorContext |
The AnnotatorContext is the interface to the configuration settings and other metadata of an AnalysisEngine. More... | |
class | BasicArrayFS |
A on object representing an array of CAS elements. More... | |
class | ArrayFS |
A ArrayFS object implements an array of FeatureStructure values. More... | |
class | FloatArrayFS |
A FloatArrayFS object implements an array of float values. More... | |
class | IntArrayFS |
A IntArrayFS object implements an array of int values. More... | |
class | StringArrayFS |
A StringArrayFS object implements an array of string values. More... | |
class | BooleanArrayFS |
A ByteArrayFS object implements an array of byte values. More... | |
class | ByteArrayFS |
A ByteArrayFS object implements an array of byte values. More... | |
class | ShortArrayFS |
A ShortArrayFS object implements an array of short values. More... | |
class | LongArrayFS |
A ShortArrayFS object implements an array of short values. More... | |
class | DoubleArrayFS |
A StringArrayFS object implements an array of string values. More... | |
class | Capability |
Defines the capability of a TextAnalysisEngine in terms of the required input and output types and features and the supported languages. More... | |
class | CAS |
The CAS (Common Analysis System) is the container where all feature structures are stored and maintained. More... | |
class | SofaFS |
The Sofa is implemented as a feature structure of type uima.cas.Sofa. More... | |
class | AnnotationFS |
Class AnnotationFS derives from a standard FeatureStrucure and extends with convenience functions specific for feature structures of type annotation. More... | |
class | ANIterator |
Iterator over AnnotationFS objects in a CAS annotation index (ANIndex). More... | |
class | ANIndex |
This class represents a single index over feature structures of type annotation. More... | |
class | 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... | |
class | CASIterator |
class | CASWriterABase |
This is an abstract base class for CAS writers, i.e., a class which can write a CAS to an ostrema. More... | |
class | XMLWriterABase |
class | CCSID |
The class CCSID used to represent a CCSID, now a char* encoding string. More... | |
class | ConfigurationParameter |
Contains the definition of a configuration parameter, for example its name and its type. More... | |
class | NameValuePair |
Contains the value for a certain parameter. More... | |
class | ConfigurationGroup |
Contains allConfigurationParameter objects for a certain configuration group. More... | |
class | SettingsForGroup |
Contains allNameValuePair objects for a certain configuration group. More... | |
class | CodePage2UnicodeConverter |
The class CodePage2UnicodeConverter converts all characters in a specified buffer into UNICODE (CCSID: CCSID::EnCCSID_UCS2). More... | |
class | DotTypeSystemWriter |
A class which outputs the type system in the dot graphical language. More... | |
class | AnalysisEngine |
An AnalysisEngine can be used for analyzing all kinds of unstructured information. More... | |
class | TextAnalysisEngine |
class | Framework |
class | EngineState |
The class EngineState maintains the state of the engine. More... | |
class | ErrorMessage |
Class ErrorMessage: this is a helper class for main class ErrorInfo and ErrorContext . More... | |
class | ErrorContext |
Class ErrorContext: this is a helper class for main class Exception . More... | |
class | ErrorInfo |
Class ErrorInfo : This is the base class for all error information used in UIMACPP. More... | |
class | Exception |
Class Exception: This is the base class for all exceptions used in UIMACPP group projects. More... | |
class | FeatureStructure |
Our feature structure. More... | |
class | FSIndex |
This class represents a single index over feature structures of some type. More... | |
class | FSIndexRepository |
Repository of indexes over feature structures. More... | |
class | FSIterator |
Iterator over FeatureStructure objects in a CAS Index. More... | |
class | ImportDescription |
A Import object represents a pointer to a descriptor file to be imported. More... | |
class | Language |
The class Language models languages in UIMACPP. More... | |
class | BasicListFS |
A on object representing a list of elements from the CAS. More... | |
class | ListFS |
A ListFS object implements a list of FeatureStructure objects It is derived from the BasicListFS template interface so all interesting member functions are derived from BasicListFS. More... | |
class | FloatListFS |
A FloatListFS object implements a list of float values. More... | |
class | IntListFS |
A IntListFS object implements a list of int values. More... | |
class | StringListFS |
A StringListFS object implements a list of string values. More... | |
class | LogStream |
The class LogStream logs user-related information which would otherwise be hard to concatenate into a single string. More... | |
class | Logger |
This defines the interface for Loggers. More... | |
class | FileLogger |
This class is the built in Logger that writes log message to a file. More... | |
class | LogFacility |
The class LogFacility logs user-related information for debugging or error recording purposes. More... | |
class | ResourceABase |
This class is the abstract base class for all resources handled by the resource manager (uima::ResourceManager). More... | |
class | FileResource |
File resources are resources of the form "key.kind" (e.g. More... | |
class | LanguageKindFileResource |
LanguageKindFileResources are a special case of FileResources in that the key always denotes a language (e.g. More... | |
class | ResourceFactoryABase |
The resource manager creates resources through an instance of this class. More... | |
class | LanguageKindFileResourceFactory |
A special factory for LanguageKindFileResources. More... | |
class | ResourceManager |
The class ResourceManager is used to manage the UIMACPP resources. More... | |
class | ResultSpecification |
An engine/annotator gets a set like this passed in its process() function and is required to check this set to see which kind of output types and features it is supposed to create. More... | |
class | SofaID |
A SofaID object contains the handle to a particular Sofa in the CAS. More... | |
class | SofaMapping |
A SofaMapping object represents mapping of a Sofa name assigned by a component to a Sofa name assigned by an aggregate which could be either an aggregate TAE or a CPE. More... | |
class | SofaDataStream |
The SofaDataStream class provides stream access to Sofa data in a Sofa feature strucure in the CAS. More... | |
class | LocalSofaDataStream |
This class implements stream access to Sofa data for a Local Sofa. More... | |
class | RemoteSofaDataStream |
This class implements stream access to Sofa data for a remote Sofa. More... | |
class | SofaStreamHandler |
The class SofaStreamHandler defines the API methods that must be implemented to support reading custom URI schemes for reading. More... | |
class | MetaDataObject |
The base class of all configuration objects. More... | |
class | OperationalProperties |
Specifies operational properties of a UIMA component. More... | |
class | FSIndexKeyDescription |
Contains the description of an index key, i.e. More... | |
class | FSIndexDescription |
Defines an index for a specific type. More... | |
class | FlowConstraints |
Specifies the order in which Annotators are invoked. More... | |
class | FixedFlow |
Specifies the order in which Annotators are invoked. More... | |
class | CapabilityLanguageFlow |
class | AnalysisEngineMetaData |
Contains the MetaDataObject s that are defined for both delegate and aggregate TextAnalysisEngine s, for example the description of the types used and the capabilities of the TAE. More... | |
class | AnalysisEngineDescription |
Contains all MetaDataObject s for a particular TextAnalysisEngine that are found in a TextAnalysisEngine Resource Specifier XML file. More... | |
class | TextAnalysisEngineSpecifier |
class | XMLParser |
A UIMA XMLParser parses XML documents and generates UIMA component descriptor object represented in the XML. More... | |
class | TextAnalysisEngineSpecifierBuilder |
class | Timer |
Class ClTimer is a tool class to help with timing. More... | |
class | TokenProperties |
The class TokenProperties is used to encapsulate information about the characters occuring in a token (for example, upper and lower). More... | |
class | TypeOrFeature |
Wrapper class to encapsulate either a uima::Type or a uima::Feature object since both types and features can be used as parts of a result specification. More... | |
class | TypeNameSpace |
An accessor object that gives access to all types that share a common namespace. More... | |
class | TypeNameSpaceImport |
This class is usefull to bundle several TypeNameSpace objects into a lookup sequence that can be used to lookup unqualified type names. More... | |
class | Feature |
This class represents a feature in the type hierarchy of the type system. More... | |
class | Type |
This class represents a type in the type hierarchy of the type system. More... | |
class | TypeSystem |
Class TypeSystem represents all knowledge about types in the FeatureStructure system. More... | |
class | AllowedValue |
If a type can only contain an enumeration of values, there is an AllowedValue object for each value. More... | |
class | FeatureDescription |
Defines a feature by its name and the range type that its values can assume. More... | |
class | TypeDescription |
Defines a type by its name and the name of its super type. More... | |
class | TypePriority |
Contains an ordered list of type names. More... | |
class | TypeSystemDescription |
Contains all TypeDescription and TypePriority objects for a TextAnalysisEngine . More... | |
class | Unicode2CodePageConverter |
The class Unicode2CodePageConverter is used to convert all characters in a specified buffer from UNICODE (CCSID: CCSID::EnCCSID_UCS2), to another buffer with specified CCSID. More... | |
class | UnicodeStringRef |
The class UnicodeStringRef provides support for non zero-terminated strings that are presented as pointers to Unicode character arrays with an associated length. More... | |
class | XCASDeserializer |
The XCASDeserializer class provides static methods to deserializes cas data in XCAS format into a CAS. More... | |
class | FSInfo |
class | XCASDeserializerHandler |
class | XMLErrorHandler |
The class XMLErrorHandler is used as a generic Handler for the XML4C SAX error interface mapping XML to UIMACPP exceptions. More... | |
class | XMLDumpWriter |
class UIMA_LINK_IMPORTSPEC XMLWriterABase : public CASWriterABase { protected: void normalize(UnicodeStringRef const & in, icu::UnicodeString& out) const; public: XMLWriterABase(CAS const & crCAS, bool bAddDocBuffer); virtual ~XMLWriterABase(); More... | |
class | XCASWriter |
Namespaces | |
namespace | internal |
This namespace is only to be used internally to UIMACPP. | |
namespace | lowlevel |
This namespace contains lowlevel access functions not conforming to UIMA API and not covered by standard documentation and tutorial. | |
namespace | util |
Typedefs | |
typedef BasicArrayFS < FeatureStructure, internal::gs_tyFSArrayType > | BasicFSArrayFS |
typedef BasicArrayFS< float, internal::gs_tyFloatArrayType > | BasicFloatArrayFS |
typedef BasicArrayFS< int, internal::gs_tyIntArrayType > | BasicIntArrayFS |
typedef BasicArrayFS < UnicodeStringRef, internal::gs_tyStringArrayType > | BasicStringArrayFS |
typedef BasicArrayFS< bool, internal::gs_tyBooleanArrayType > | BasicBooleanArrayFS |
typedef BasicArrayFS< char, internal::gs_tyByteArrayType > | BasicByteArrayFS |
typedef BasicArrayFS< short, internal::gs_tyShortArrayType > | BasicShortArrayFS |
typedef BasicArrayFS< INT64, internal::gs_tyLongArrayType > | BasicLongArrayFS |
typedef BasicArrayFS< double, internal::gs_tyDoubleArrayType > | BasicDoubleArrayFS |
typedef enum uima::EnIteratorAmbiguity_ | EnIteratorAmbiguity |
This enum is used for annotation iterators to determine there iteration behaviour. | |
typedef apr_dso_handle_sym_t | TyProcedure |
typedef signed long | TyErrorId |
A type for all UIMACPP error ids. | |
typedef BasicListFS < FeatureStructure, internal::gs_tyFSListType, internal::gs_tyEListType, internal::gs_tyNEListType, internal::gs_tyHeadFeature, internal::gs_tyTailFeature > | BasicListFS |
typedef void * | TySofaDataPointer |
typedef SofaStreamHandler *(* | TyMakeStreamHandler )(void) |
typedef long | TyDocTextDistance |
typedef unsigned long | TyMessageId |
typedef size_t | TyDocIndex |
typedef void * | TyHandle |
typedef unsigned short | TyComponentId |
Enumerations | |
enum | EnIteratorAmbiguity_ { enAmbiguous, enUnambiguous, enNumberOfIteratorAmbiguityElems } |
This enum is used for annotation iterators to determine there iteration behaviour. More... | |
Functions | |
UIMA_ANNOTATOR_LINK_IMPORTSPEC Annotator * | makeAE () |
UIMA_EXC_CLASSDECLARE (FSIsNotArrayException, CASException) | |
UIMA_EXC_CLASSDECLARE (FSArrayOutOfBoundsException, CASException) | |
UIMA_EXC_CLASSDECLARE (CouldNotCreateFSOfFinalTypeException, CASException) | |
UIMA_EXC_CLASSDECLARE (DuplicateSofaNameException, CASException) | |
UIMA_EXC_CLASSDECLARE (InvalidBaseCasMethod, CASException) | |
UIMA_EXC_CLASSDECLARE (CASIteratorException, uima::Exception) | |
------------------------------------------------ CASIterator | |
UIMA_EXC_CLASSDECLARE (CASException, Exception) | |
UIMA_EXC_CLASSDECLARE (NotYetImplementedException, CASException) | |
UIMA_EXC_CLASSDECLARE (SofaDataStreamException, CASException) | |
UIMA_EXC_CLASSDECLARE (ConfigException, Exception) | |
UIMA_EXC_CLASSDECLARE (ConfigParamException, ConfigException) | |
UIMA_EXC_CLASSDECLARE (UnknownTypeException, Exception) | |
UIMA_EXC_CLASSDECLARE (UnknownFeatureException, Exception) | |
UIMA_EXC_CLASSDECLARE (UnknownRangeTypeException, Exception) | |
UIMA_EXC_CLASSDECLARE (IncompatibleRangeTypeException, Exception) | |
UIMA_EXC_CLASSDECLARE (AllowedStringValuesIncompatibleException, Exception) | |
UIMA_EXC_CLASSDECLARE (TypePriorityConflictException, Exception) | |
UIMA_EXC_CLASSDECLARE (IncompatibleIndexDefinitionsException, Exception) | |
UIMA_EXC_CLASSDECLARE (IncompatibleParentTypesException, Exception) | |
UIMA_EXC_CLASSDECLARE (CASIncompatibilityException, Exception) | |
UIMA_EXC_CLASSDECLARE (UimaAnalysisComponentException, Exception) | |
std::ostream & | operator<< (std::ostream &rclOStream, const ErrorMessage &crclExceptionMessage) |
ErrorMessage output support for streams. | |
std::ostream & | operator<< (std::ostream &rclOStream, const ErrorContext &crclExceptionContext) |
ErrorContext output support for streams. | |
std::ostream & | operator<< (std::ostream &rclOStream, const ErrorInfo &crclErrorInfo) |
ErrorInfo output support for streams. | |
std::ostream & | operator<< (std::ostream &rclOStream, const Exception &crclException) |
Exception output support for streams. | |
UIMA_EXC_CLASSDECLARE (AprFailureException, Exception) | |
The following exception is used to report failures from APR functions. | |
UIMA_EXC_CLASSDECLARE (InvalidFSObjectException, CASException) | |
UIMA_EXC_CLASSDECLARE (FeatureNotAppropriateException, CASException) | |
UIMA_EXC_CLASSDECLARE (IncompatibleValueTypeException, CASException) | |
UIMA_EXC_CLASSDECLARE (FSIsNotStringException, CASException) | |
UIMA_EXC_CLASSDECLARE (WrongStringValueException, CASException) | |
UIMA_EXC_CLASSDECLARE (InvalidIndexObjectException, CASException) | |
UIMA_EXC_CLASSDECLARE (WrongFSTypeForIndexException, CASException) | |
UIMA_EXC_CLASSDECLARE (InvalidIndexIDException, CASException) | |
UIMA_EXC_CLASSDECLARE (FSIsNotListException, CASException) | |
UIMA_EXC_CLASSDECLARE (ListIsEmptyException, CASException) | |
UIMA_EXC_CLASSDECLARE (ListIsCircularException, CASException) | |
UIMA_ANNOTATOR_LINK_IMPORTSPEC SofaStreamHandler * | makeHandler () |
UIMA_EXC_CLASSDECLARE (DuplicateConfigElemException, uima::Exception) | |
UIMA_EXC_CLASSDECLARE (ValidationException, uima::Exception) | |
template<class InputIterator, class T> | |
size_t | countValues (InputIterator it1, InputIterator it2, T val) |
UIMA_EXC_CLASSDECLARE (ConfigParamLookupException, ConfigException) | |
UIMA_EXC_CLASSDECLARE (InvalidXMLException, uima::Exception) | |
std::string | tafCurrTimeDateString () |
Function currTimeString is a help function to return the current time/data as a string. | |
UIMA_EXC_CLASSDECLARE (TypeSystemAlreadyCommittedException, CASException) | |
UIMA_EXC_CLASSDECLARE (InvalidFSFeatureObjectException, CASException) | |
UIMA_EXC_CLASSDECLARE (InvalidFSTypeObjectException, CASException) | |
std::ostream & | operator<< (std::ostream &outStream, const uima::UnicodeStringRef &crUStrRef) |
Output stream support for UnicodeStringRef (Note: inside namespace). | |
Predefined Exceptions (beginning of an error hierarchy). | |
The following predefined exceptions are supposed to structure the use of exceptions, help with avoiding multiple definitions of common exceptions (e.g.
file not found) and provide a start for an exception hierarchy. | |
UIMA_EXC_CLASSDECLARE (Uima_logic_error, Exception) | |
The following classes reimplement the ANSI standard exception hierarchy from stdexcept.h as exceptions with context and message id support. | |
UIMA_EXC_CLASSDECLARE (Uima_runtime_error, Exception) | |
runtime error | |
UIMA_EXC_CLASSDECLARE (Uima_domain_error, Uima_logic_error) | |
domain error | |
UIMA_EXC_CLASSDECLARE (Uima_invalid_argument, Uima_logic_error) | |
invalid argument | |
UIMA_EXC_CLASSDECLARE (Uima_length_error, Uima_logic_error) | |
length error | |
UIMA_EXC_CLASSDECLARE (Uima_out_of_range, Uima_logic_error) | |
out of range | |
UIMA_EXC_CLASSDECLARE (Uima_range_error, Uima_runtime_error) | |
range error | |
UIMA_EXC_CLASSDECLARE (Uima_overflow_error, Uima_runtime_error) | |
overflow error | |
UIMA_EXC_CLASSDECLARE (Uima_underflow_error, Uima_runtime_error) | |
underflow error | |
UIMA_EXC_CLASSDECLARE (ConsoleAbortExc, Exception) | |
The following exceptions are used by helper test classes that are no longer in the UIMACPP library: CommandLineDriver DocBuffer ParseHandlers. | |
UIMA_EXC_CLASSDECLARE (ExcDocBuffer, Uima_out_of_range) | |
UIMA_EXC_CLASSDECLARE (ParseHandlerExc, Exception) | |
UIMA_EXC_CLASSDECLARE (ExcIllFormedInputError, Uima_runtime_error) | |
The following classes provide a starting point for an exception hierarchy. | |
UIMA_EXC_CLASSDECLARE (ExcInvalidParameter, Uima_invalid_argument) | |
Invalid Parameter. | |
UIMA_EXC_CLASSDECLARE (ExcIndexOutOfRange, Uima_out_of_range) | |
Index out of Range. | |
UIMA_EXC_CLASSDECLARE (ExcInvalidRequest, Uima_runtime_error) | |
Device Error. | |
UIMA_EXC_CLASSDECLARE (ExcResourceExhausted, Uima_runtime_error) | |
Resource Exhausted. | |
UIMA_EXC_CLASSDECLARE (ExcOutOfMemory, ExcResourceExhausted) | |
Out of Memory. | |
UIMA_EXC_CLASSDECLARE (ExcFileNotFoundError, Uima_runtime_error) | |
Out of System Resource. | |
UIMA_EXC_CLASSDECLARE (ExcWinCException, Uima_runtime_error) | |
UIMA_EXC_CLASSDECLARE (CodePageConversionException, Exception) | |
Used to report code page conversion errors. | |
Conventional conversion functions: POD to/from string. | |
template BS_TEMPLATE_DEFINITION_ARGS BASIC_STRING_TEMPLATE | long2String (long l, BASIC_STRING_TEMPLATE &s) |
Converts a long to a string. | |
template BS_TEMPLATE_DEFINITION_ARGS long | string2Long (const BASIC_STRING_TEMPLATE &s) |
Converts a string to a long. | |
template BS_TEMPLATE_DEFINITION_ARGS BASIC_STRING_TEMPLATE | double2String (double d, BASIC_STRING_TEMPLATE &s) |
Converts a double to a string. | |
template BS_TEMPLATE_DEFINITION_ARGS BASIC_STRING_TEMPLATE | double2String (double d, size_t uiDigitsAfterPeriod, BASIC_STRING_TEMPLATE &s) |
Converts a double to a string with a specified number of digits after the period. | |
template BS_TEMPLATE_DEFINITION_ARGS double | string2Double (const BASIC_STRING_TEMPLATE &s) |
Converts a string to a double. | |
template BS_TEMPLATE_DEFINITION_ARGS BASIC_STRING_TEMPLATE | bool2String (bool b, BASIC_STRING_TEMPLATE &s) |
Converts a bool to a string, either "true" or "false". | |
template BS_TEMPLATE_DEFINITION_ARGS bool | string2Bool (const BASIC_STRING_TEMPLATE &s) |
Converts a string ("true", "ON", "YES", "T", "Y", "+", "1" = true else false) to a bool. | |
Template function for conversion <EM>to</EM> string. | |
template<class T> | |
void | convertToString (const T &crtSource, std::string &rstrTarget) |
Generic template function (assumes T to be integral numeric type). | |
void | convertToString (const icu::UnicodeString &crtSource, std::string &rstrTarget) |
Explicit specialization for UString. | |
void | convertToString (const std::string &crtSource, std::string &rstrTarget) |
Explicit specialization for string. | |
void | convertToString (const double &crtSource, std::string &rstrTarget) |
Explicit specialization for double. | |
void | convertToString (bool const &crtSource, std::string &rstrTarget) |
Explicit specialization for bool. | |
void | convertToString (const float &crtSource, std::string &rstrTarget) |
Explicit specialization for float. | |
Template function for conversion <EM>from</EM> string. | |
template<class T> | |
void | convertFromString (const std::string &crstrSource, T &crtTarget) |
Generic template function (assumes T to be integral numeric type). | |
void | convertFromString (const std::string &crstrSource, icu::UnicodeString &crTarget) |
Explicit specialization for UString. | |
void | convertFromString (const std::string &crstrSource, std::string &crtTarget) |
Explicit specialization for string. | |
void | convertFromString (const std::string &crstrSource, double &crtTarget) |
Explicit specialization for double. | |
void | convertFromString (const std::string &crstrSource, float &crtTarget) |
Explicit specialization for float. | |
void | convertFromString (const std::string &crstrSource, bool &crtTarget) |
Explicit specialization for boole. | |
vector to/from delimited string conversion routines | |
UnicodeStringRef | strtrim (const UnicodeStringRef &s) |
Removes whitespace from both ends of a string. | |
int32_t | delimitedUnicodeStringRef2Vector (std::vector< uima::UnicodeStringRef > &rveclstrOutput, const UChar *pcInput, int32_t uiInputLength, const UChar *cpszDelimiters, bool bTrimString, bool bInsertEmptyStrings) |
Splits a delimited string into pieces and stores the results in a vector of strings. | |
int32_t | delimitedUnicodeStringRef2Vector (std::vector< UnicodeStringRef > &veclstrOutput, const UChar *pcInput, const UChar *cpszDelimiters, bool bTrimString, bool bInsertEmptyStrings) |
Variables | |
const size_t | UIMA_RESOURCEMANAGER_PREFIX_MAX_LENGTH = 3 |
const char | TYPENAMESPACE_SEP = '.' |
The constant we use to seperate namespace parts: A period. |
typedef BasicArrayFS< FeatureStructure, internal::gs_tyFSArrayType > uima::BasicFSArrayFS |
typedef BasicArrayFS< float, internal::gs_tyFloatArrayType > uima::BasicFloatArrayFS |
typedef BasicArrayFS< int, internal::gs_tyIntArrayType > uima::BasicIntArrayFS |
typedef BasicArrayFS< UnicodeStringRef, internal::gs_tyStringArrayType > uima::BasicStringArrayFS |
typedef BasicArrayFS< bool, internal::gs_tyBooleanArrayType > uima::BasicBooleanArrayFS |
typedef BasicArrayFS< char, internal::gs_tyByteArrayType > uima::BasicByteArrayFS |
typedef BasicArrayFS<short, internal::gs_tyShortArrayType > uima::BasicShortArrayFS |
typedef BasicArrayFS< INT64, internal::gs_tyLongArrayType > uima::BasicLongArrayFS |
typedef BasicArrayFS<double, internal::gs_tyDoubleArrayType > uima::BasicDoubleArrayFS |
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()
typedef apr_dso_handle_sym_t uima::TyProcedure |
typedef signed long uima::TyErrorId |
A type for all UIMACPP error ids.
typedef BasicListFS< UnicodeStringRef, internal::gs_tyStringListType, internal::gs_tyEStringListType, internal::gs_tyNEStringListType, internal::gs_tyStringHeadFeature, internal::gs_tyStringTailFeature > uima::BasicListFS |
typedef void* uima::TySofaDataPointer |
typedef SofaStreamHandler*(* uima::TyMakeStreamHandler)(void) |
typedef long uima::TyDocTextDistance |
typedef unsigned long uima::TyMessageId |
typedef size_t uima::TyDocIndex |
typedef void* uima::TyHandle |
typedef unsigned short uima::TyComponentId |
This enum is used for annotation iterators to determine there iteration behaviour.
This is used in ANIndex::subIterator(), AnnotationFS::subIterator() and ANIterator::subIterator()
UIMA_ANNOTATOR_LINK_IMPORTSPEC Annotator* uima::makeAE | ( | ) |
uima::UIMA_EXC_CLASSDECLARE | ( | FSIsNotArrayException | , | |
CASException | ||||
) |
uima::UIMA_EXC_CLASSDECLARE | ( | FSArrayOutOfBoundsException | , | |
CASException | ||||
) |
uima::UIMA_EXC_CLASSDECLARE | ( | CouldNotCreateFSOfFinalTypeException | , | |
CASException | ||||
) |
uima::UIMA_EXC_CLASSDECLARE | ( | DuplicateSofaNameException | , | |
CASException | ||||
) |
uima::UIMA_EXC_CLASSDECLARE | ( | InvalidBaseCasMethod | , | |
CASException | ||||
) |
uima::UIMA_EXC_CLASSDECLARE | ( | CASIteratorException | , | |
uima::Exception | ||||
) |
------------------------------------------------ CASIterator
------------------------------------------------
uima::UIMA_EXC_CLASSDECLARE | ( | CASException | , | |
Exception | ||||
) |
uima::UIMA_EXC_CLASSDECLARE | ( | NotYetImplementedException | , | |
CASException | ||||
) |
uima::UIMA_EXC_CLASSDECLARE | ( | SofaDataStreamException | , | |
CASException | ||||
) |
uima::UIMA_EXC_CLASSDECLARE | ( | ConfigException | , | |
Exception | ||||
) |
uima::UIMA_EXC_CLASSDECLARE | ( | ConfigParamException | , | |
ConfigException | ||||
) |
uima::UIMA_EXC_CLASSDECLARE | ( | UnknownTypeException | , | |
Exception | ||||
) |
uima::UIMA_EXC_CLASSDECLARE | ( | UnknownFeatureException | , | |
Exception | ||||
) |
uima::UIMA_EXC_CLASSDECLARE | ( | UnknownRangeTypeException | , | |
Exception | ||||
) |
uima::UIMA_EXC_CLASSDECLARE | ( | IncompatibleRangeTypeException | , | |
Exception | ||||
) |
uima::UIMA_EXC_CLASSDECLARE | ( | AllowedStringValuesIncompatibleException | , | |
Exception | ||||
) |
uima::UIMA_EXC_CLASSDECLARE | ( | TypePriorityConflictException | , | |
Exception | ||||
) |
uima::UIMA_EXC_CLASSDECLARE | ( | IncompatibleIndexDefinitionsException | , | |
Exception | ||||
) |
uima::UIMA_EXC_CLASSDECLARE | ( | IncompatibleParentTypesException | , | |
Exception | ||||
) |
uima::UIMA_EXC_CLASSDECLARE | ( | CASIncompatibilityException | , | |
Exception | ||||
) |
uima::UIMA_EXC_CLASSDECLARE | ( | UimaAnalysisComponentException | , | |
Exception | ||||
) |
std::ostream& uima::operator<< | ( | std::ostream & | rclOStream, | |
const ErrorMessage & | crclExceptionMessage | |||
) |
ErrorMessage
output support for streams.
Assuming your message is "Trying to load function %s"
and the first argument is "begindoc"
, your output should look like this:
Trying to load function begindoc.
std::ostream& uima::operator<< | ( | std::ostream & | rclOStream, | |
const ErrorContext & | crclExceptionContext | |||
) |
ErrorContext
output support for streams.
This will first stream out the message part of the context and then (indented by spaces) the file name, function name and line number info (if present). This means you will typically get a multi-line text!
If NDEBUG
is defined your output should look like this:
Trying to load function begindoc.
In debug mode it will look like:
Trying to load function begindoc.
File : extract.cpp
Function: ExternalAnnotator::tryGetProcAddress(char*)
Line : 87
std::ostream& uima::operator<< | ( | std::ostream & | rclOStream, | |
const ErrorInfo & | crclErrorInfo | |||
) |
ErrorInfo
output support for streams.
This will stream out:
ErrorContext
part of the exception
If NDEBUG
is defined your output should look like this:
Recoverable : No Error number : -1 Error : Cannot find function address in DLL/library While : Trying to load function begindoc While : Trying to load Annotator IXTalent Test While : Trying to initialize UIMACPP.
In debug mode it will look like:
Error number : -1
Recoverable : No
Error : Cannot find function address in DLL/library
While : Trying to load function begindoc
File : extract.cpp
Function: ExternalAnnotator::tryGetProcAddress(char*)
Line : 87
While : Trying to load Annotator IXTalent Test
File : extracts.cpp
Function: Annotators::init(AnnotatorsConfig&)
Line : 116
While : Trying to initialize UIMACPP.
File : framewrk.cpp
Function: Framework::init(const IString&)
Line : 128
std::ostream& uima::operator<< | ( | std::ostream & | rclOStream, | |
const Exception & | crclException | |||
) |
Exception
output support for streams.
This will stream out:
ErrorContext
part of the exception
If NDEBUG
is defined your output should look like this:
Exception : AnnotatorException Error number : -1 Recoverable : No Error : Cannot find function address in DLL/library While : Trying to load function begindoc While : Trying to load Annotator IXTalent Test While : Trying to initialize UIMACPP.
In debug mode it will look like:
Exception : AnnotatorException
Error number : -1
Recoverable : No
Error : Cannot find function address in DLL/library
While : Trying to load function begindoc
File : extract.cpp
Function: ExternalAnnotator::tryGetProcAddress(char*)
Line : 87
While : Trying to load Annotator IXTalent Test
File : extracts.cpp
Function: Annotators::init(AnnotatorsConfig&)
Line : 116
While : Trying to initialize UIMACPP.
File : framewrk.cpp
Function: Framework::init(const IString&)
Line : 128
uima::UIMA_EXC_CLASSDECLARE | ( | Uima_logic_error | , | |
Exception | ||||
) |
The following classes reimplement the ANSI standard exception hierarchy from stdexcept.h as exceptions with context and message id support.
This is the reason why they have the "unconventional" names: Uima_<ansi name>logic error
uima::UIMA_EXC_CLASSDECLARE | ( | Uima_runtime_error | , | |
Exception | ||||
) |
runtime error
uima::UIMA_EXC_CLASSDECLARE | ( | Uima_domain_error | , | |
Uima_logic_error | ||||
) |
domain error
uima::UIMA_EXC_CLASSDECLARE | ( | Uima_invalid_argument | , | |
Uima_logic_error | ||||
) |
invalid argument
uima::UIMA_EXC_CLASSDECLARE | ( | Uima_length_error | , | |
Uima_logic_error | ||||
) |
length error
uima::UIMA_EXC_CLASSDECLARE | ( | Uima_out_of_range | , | |
Uima_logic_error | ||||
) |
out of range
uima::UIMA_EXC_CLASSDECLARE | ( | Uima_range_error | , | |
Uima_runtime_error | ||||
) |
range error
uima::UIMA_EXC_CLASSDECLARE | ( | Uima_overflow_error | , | |
Uima_runtime_error | ||||
) |
overflow error
uima::UIMA_EXC_CLASSDECLARE | ( | Uima_underflow_error | , | |
Uima_runtime_error | ||||
) |
underflow error
uima::UIMA_EXC_CLASSDECLARE | ( | ConsoleAbortExc | , | |
Exception | ||||
) |
The following exceptions are used by helper test classes that are no longer in the UIMACPP library: CommandLineDriver DocBuffer ParseHandlers.
uima::UIMA_EXC_CLASSDECLARE | ( | ExcDocBuffer | , | |
Uima_out_of_range | ||||
) |
uima::UIMA_EXC_CLASSDECLARE | ( | ParseHandlerExc | , | |
Exception | ||||
) |
uima::UIMA_EXC_CLASSDECLARE | ( | ExcIllFormedInputError | , | |
Uima_runtime_error | ||||
) |
The following classes provide a starting point for an exception hierarchy.
Access Error Assertion Failure Ill formed input
uima::UIMA_EXC_CLASSDECLARE | ( | ExcInvalidParameter | , | |
Uima_invalid_argument | ||||
) |
Invalid Parameter.
uima::UIMA_EXC_CLASSDECLARE | ( | ExcIndexOutOfRange | , | |
Uima_out_of_range | ||||
) |
Index out of Range.
uima::UIMA_EXC_CLASSDECLARE | ( | ExcInvalidRequest | , | |
Uima_runtime_error | ||||
) |
Device Error.
Invalid Request
uima::UIMA_EXC_CLASSDECLARE | ( | ExcResourceExhausted | , | |
Uima_runtime_error | ||||
) |
Resource Exhausted.
uima::UIMA_EXC_CLASSDECLARE | ( | ExcOutOfMemory | , | |
ExcResourceExhausted | ||||
) |
Out of Memory.
uima::UIMA_EXC_CLASSDECLARE | ( | ExcFileNotFoundError | , | |
Uima_runtime_error | ||||
) |
Out of System Resource.
Out of Window Resource File not Found
uima::UIMA_EXC_CLASSDECLARE | ( | ExcWinCException | , | |
Uima_runtime_error | ||||
) |
uima::UIMA_EXC_CLASSDECLARE | ( | CodePageConversionException | , | |
Exception | ||||
) |
Used to report code page conversion errors.
uima::UIMA_EXC_CLASSDECLARE | ( | AprFailureException | , | |
Exception | ||||
) |
The following exception is used to report failures from APR functions.
uima::UIMA_EXC_CLASSDECLARE | ( | InvalidFSObjectException | , | |
CASException | ||||
) |
uima::UIMA_EXC_CLASSDECLARE | ( | FeatureNotAppropriateException | , | |
CASException | ||||
) |
uima::UIMA_EXC_CLASSDECLARE | ( | IncompatibleValueTypeException | , | |
CASException | ||||
) |
uima::UIMA_EXC_CLASSDECLARE | ( | FSIsNotStringException | , | |
CASException | ||||
) |
uima::UIMA_EXC_CLASSDECLARE | ( | WrongStringValueException | , | |
CASException | ||||
) |
uima::UIMA_EXC_CLASSDECLARE | ( | InvalidIndexObjectException | , | |
CASException | ||||
) |
uima::UIMA_EXC_CLASSDECLARE | ( | WrongFSTypeForIndexException | , | |
CASException | ||||
) |
uima::UIMA_EXC_CLASSDECLARE | ( | InvalidIndexIDException | , | |
CASException | ||||
) |
uima::UIMA_EXC_CLASSDECLARE | ( | FSIsNotListException | , | |
CASException | ||||
) |
uima::UIMA_EXC_CLASSDECLARE | ( | ListIsEmptyException | , | |
CASException | ||||
) |
uima::UIMA_EXC_CLASSDECLARE | ( | ListIsCircularException | , | |
CASException | ||||
) |
UIMA_ANNOTATOR_LINK_IMPORTSPEC SofaStreamHandler* uima::makeHandler | ( | ) |
template BS_TEMPLATE_DEFINITION_ARGS BASIC_STRING_TEMPLATE uima::long2String | ( | long | l, | |
BASIC_STRING_TEMPLATE & | s | |||
) |
Converts a long to a string.
Cannot be implemented as single argument function because of template definitions.
l | input parameter | |
s | output parameter |
References assertWithMsg.
Referenced by convertToString().
template BS_TEMPLATE_DEFINITION_ARGS long uima::string2Long | ( | const BASIC_STRING_TEMPLATE & | s | ) |
template BS_TEMPLATE_DEFINITION_ARGS BASIC_STRING_TEMPLATE uima::double2String | ( | double | d, | |
BASIC_STRING_TEMPLATE & | s | |||
) |
Converts a double to a string.
Cannot be implemented as single argument function because of template definitions.
d | input parameter | |
s | output parameter |
References assertWithMsg.
Referenced by convertToString().
template BS_TEMPLATE_DEFINITION_ARGS BASIC_STRING_TEMPLATE uima::double2String | ( | double | d, | |
size_t | uiDigitsAfterPeriod, | |||
BASIC_STRING_TEMPLATE & | s | |||
) |
Converts a double to a string with a specified number of digits after the period.
Cannot be implemented as single argument function because of template definitions.
d | input parameter. | |
uiDigitsAfterPeriod | nbr of digits after period. | |
s | output parameter. |
References assertWithMsg.
template BS_TEMPLATE_DEFINITION_ARGS double uima::string2Double | ( | const BASIC_STRING_TEMPLATE & | s | ) |
template BS_TEMPLATE_DEFINITION_ARGS BASIC_STRING_TEMPLATE uima::bool2String | ( | bool | b, | |
BASIC_STRING_TEMPLATE & | s | |||
) |
Converts a bool to a string, either "true" or "false".
Cannot be implemented as single argument function because of template definitions.
b | input parameter. | |
s | output parameter. |
Referenced by convertToString().
template BS_TEMPLATE_DEFINITION_ARGS bool uima::string2Bool | ( | const BASIC_STRING_TEMPLATE & | s | ) |
Converts a string ("true", "ON", "YES", "T", "Y", "+", "1" = true else false) to a bool.
Referenced by convertFromString().
void uima::convertToString | ( | const T & | crtSource, | |
std::string & | rstrTarget | |||
) | [inline] |
void uima::convertToString | ( | const icu::UnicodeString & | crtSource, | |
std::string & | rstrTarget | |||
) | [inline] |
Explicit specialization for UString.
void uima::convertToString | ( | const std::string & | crtSource, | |
std::string & | rstrTarget | |||
) | [inline] |
Explicit specialization for string.
void uima::convertToString | ( | const double & | crtSource, | |
std::string & | rstrTarget | |||
) | [inline] |
void uima::convertToString | ( | bool const & | crtSource, | |
std::string & | rstrTarget | |||
) | [inline] |
void uima::convertToString | ( | const float & | crtSource, | |
std::string & | rstrTarget | |||
) | [inline] |
void uima::convertFromString | ( | const std::string & | crstrSource, | |
T & | crtTarget | |||
) | [inline] |
void uima::convertFromString | ( | const std::string & | crstrSource, | |
icu::UnicodeString & | crTarget | |||
) | [inline] |
void uima::convertFromString | ( | const std::string & | crstrSource, | |
std::string & | crtTarget | |||
) | [inline] |
Explicit specialization for string.
void uima::convertFromString | ( | const std::string & | crstrSource, | |
double & | crtTarget | |||
) | [inline] |
void uima::convertFromString | ( | const std::string & | crstrSource, | |
float & | crtTarget | |||
) | [inline] |
void uima::convertFromString | ( | const std::string & | crstrSource, | |
bool & | crtTarget | |||
) | [inline] |
uima::UIMA_EXC_CLASSDECLARE | ( | DuplicateConfigElemException | , | |
uima::Exception | ||||
) |
uima::UIMA_EXC_CLASSDECLARE | ( | ValidationException | , | |
uima::Exception | ||||
) |
size_t uima::countValues | ( | InputIterator | it1, | |
InputIterator | it2, | |||
T | val | |||
) | [inline] |
uima::UIMA_EXC_CLASSDECLARE | ( | ConfigParamLookupException | , | |
ConfigException | ||||
) |
uima::UIMA_EXC_CLASSDECLARE | ( | InvalidXMLException | , | |
uima::Exception | ||||
) |
std::string uima::tafCurrTimeDateString | ( | ) | [inline] |
Function currTimeString
is a help function to return the current time/data as a string.
Note: This should be made more flexible in the output format
uima::UIMA_EXC_CLASSDECLARE | ( | TypeSystemAlreadyCommittedException | , | |
CASException | ||||
) |
uima::UIMA_EXC_CLASSDECLARE | ( | InvalidFSFeatureObjectException | , | |
CASException | ||||
) |
uima::UIMA_EXC_CLASSDECLARE | ( | InvalidFSTypeObjectException | , | |
CASException | ||||
) |
std::ostream & uima::operator<< | ( | std::ostream & | outStream, | |
const uima::UnicodeStringRef & | crUStrRef | |||
) |
Output stream support for UnicodeStringRef (Note: inside namespace).
UnicodeStringRef uima::strtrim | ( | const UnicodeStringRef & | s | ) | [inline] |
Removes whitespace from both ends of a string.
Template function using isspace_templ()
.
References uima::UnicodeStringRef::getBuffer(), uima::UnicodeStringRef::length(), and uima::UnicodeStringRef::UnicodeStringRef().
int32_t uima::delimitedUnicodeStringRef2Vector | ( | std::vector< uima::UnicodeStringRef > & | rveclstrOutput, | |
const UChar * | pcInput, | |||
int32_t | uiInputLength, | |||
const UChar * | cpszDelimiters, | |||
bool | bTrimString, | |||
bool | bInsertEmptyStrings | |||
) |
Splits a delimited string into pieces and stores the results in a vector of strings.
Delimiters are passed as a zero terminated string.
rveclstrOutput | (Output) The vector where the results are stored | |
pcInput | The delimited string to split. | |
uiInputLength | The number of chars in pcInput | |
cpszDelimiters | The delimiters. UChar* are interpreted as a set of delimiters. | |
bTrimString | Flag: If true, all pieces will be trimmed before storing in storeVar | |
bInsertEmptyStrings | Flag: If false, pieces that have length 0 will not be stored in storeVar |
rvecstrOutput
Referenced by delimitedUnicodeStringRef2Vector().
int32_t uima::delimitedUnicodeStringRef2Vector | ( | std::vector< UnicodeStringRef > & | veclstrOutput, | |
const UChar * | pcInput, | |||
const UChar * | cpszDelimiters, | |||
bool | bTrimString, | |||
bool | bInsertEmptyStrings | |||
) | [inline] |
References delimitedUnicodeStringRef2Vector().
const size_t uima::UIMA_RESOURCEMANAGER_PREFIX_MAX_LENGTH = 3 |
const char uima::TYPENAMESPACE_SEP = '.' |
The constant we use to seperate namespace parts: A period.