Learning
Documentation
Community
Open Exchange
Global Masters
Home > Class Reference > ENSLIB namespace > %UIMA.AnnotationStore.Store
Private  Storage   

%UIMA.AnnotationStore.Store


abstract class %UIMA.AnnotationStore.Store

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 19


Summary


Methods
FileAll FileAnnotation FileAnnotations FileFSInternal
GetAnnotationTableForType GetAnnotationTableNames GetAnnotations GetAnnotationsRS
GetDocID GetInfo GetInternalSofaID GetSofaText
GetTypeInfo Markup PurgeAllAnnotations PurgeDocumentAnnotations
SortBegin SortEnd


Parameters


• parameter ASNAME;
• parameter CHECKSUM;
• parameter IDENTIFIER;

Methods


• final classmethod FileAll(pData As %String) as %Status
Files the supplied SofA objects, including its annotations, into the Annotation Store represented by this class. THIS IS AN INTERNAL METHOD - DO NOT INVOKE
• final classmethod FileAnnotation(pAnnotation As %DynamicObject, pDocID As %String, pSofaID As %Integer = "_InitialView") as %Status
Files a single manual annotation into the Annotation Store represented by this class. If no pSofaID is supplied, it will default to the default SofA for this document.
• final classmethod FileAnnotations(pAnnotations As %DynamicArray, pDocID As %String, pSofaID As %Integer = "_InitialView") as %Status
Files an array of manual annotations into the Annotation Store represented by this class. If no pSofaID is supplied, it will default to the default SofA for this document.
• final classmethod FileFSInternal(pFS As %DynamicObject = "", pFSMap As %DynamicObject, pDocID As %String, ByRef pFiledAnnotations, ByRef pFSTypes, Output pIDInfo As %List, pParentID As %Integer = 0) as %Status
pFS (%DynamicObject) = FS to be filed, or its reference in pFSMap pFSMap (%DynamicObject<%String,%DynamicObject>) = map of FSes, indexed by pFSRef pFSTypes (array<%String,Type>) = array of Type objects, indexed by full type name THIS IS AN INTERNAL METHOD - DO NOT INVOKE
• private final classmethod FileTypeHelper(pTypeAbbr As %String, ByRef typeAbbrToTypeId, ByRef childAbbrToParentAbbr, ByRef pFSTypes) as %DynamicObject
Helper method for filing FS type info into the Type table. THIS IS AN INTERNAL METHOD - DO NOT INVOKE
• abstract classmethod GetAnnotationTableForType(pType As %String, Output pTOP As %Boolean) as %String
Utility method returning the table name corresponding to the supplied pType. A return value of "" means this annotation type will not be stored.
• abstract classmethod GetAnnotationTableNames(Output pTables) as %Status

Returns the names of the tables making up this Annotation Store

pTables(n) = tableName pTables(n, columnName) = type
• classmethod GetAnnotations(pRequest As %DynamicObject = "", Output pOutput As %DynamicAbstractObject, pOutputFormat As %String = "raw") as %Status
Retrieves an array of annotation objects satisfying the supplied request object:
{	"docIDs" : [ 123, 345, ... ], 						// (default is empty)
	"maxRows" : 500 (default = 500),
	"columns" : [ "docid", "begin", "end", "type" ],	// (default is "*", case insensitive)
	"tables" : [ "annotations", ... ], 					// (default is empty)
	"types" : [ "com.intersystems.uima.*", 
			"org.apache.uima.tcas.DocumentAnnotation" ] 	// (ORed together, default is empty)
}
• classmethod GetAnnotationsRS(pRequest As %DynamicObject = "", Output pResultSet As %SQL.StatementResult, Output pColumnTypes) as %Status
Retrieves a list of annotations satisfying pRequest as a result set. See also GetAnnotations for more details on the request object. Values are returned through pResultSet, which has columns according to what was requested in the "columns" property of pRequest, which defaults to all regular columns.
• abstract classmethod GetDocID(pID As %Integer) as %RawString
Retrieves the DocID for a given SofA, identified by its internal ID
• final classmethod GetInfo(Output pInfo As %DynamicObject, pIncludeStatistics As %Boolean = 1) as %Status
Retrieves an object describing this Annotation Store
• abstract classmethod GetInternalSofaID(pDocID As %RawString, pSofaID As %String = "_InitialView") as %Integer
Retrieves the SofA's ID for a given record and sofaID (such as "_InitialView")
• abstract classmethod GetSofaText(pID As %Integer) as %String
Retrieves the text contents of a given SofA, identified by its internal ID
• classmethod GetTypeInfo(Output pTypeInfo As %DynamicObject, Output pAbbreviations, pIncludeCustomRefs As %Boolean = 0) as %Status
Returns the type information for this annotation store, in the JsonCasSerializer header format.
• classmethod Markup(Output pText As %String, pDocID As %RawString, pSofaID As %String = "_InitialView", pRequest As %DynamicObject = "", ByRef pMarkup As %DynamicObject = "") as %Status
Marks up the default SofA for the record identified by pDocID For pRequest, see GetAnnotations, but only the "types" and "tables" properties are supported. pMarkup object format:
{	"method" : "CSS", (= default)
	"feature" : "Type", (= default)
	"styleMap" : { 						// if supplied, this takes precedence over the top-level "types"
		"com.intersystems.*" : "myStyle" 	// if not supplied, it will be generated automatically per actual type
	}
}
• abstract classmethod PurgeAllAnnotations(pPurgeManualAnnotations As %Boolean = 0) as %Status
Purges all annotations in the store. If pPurgeManualAnnotations is false (default), any annotations added manually and the SofA they may refer to, will be preserved.
• abstract classmethod PurgeDocumentAnnotations(pDocID As %String, pPurgeManualAnnotations As %Boolean = 0) as %Status
Purges all annotations in the store for a given document. If pPurgeManualAnnotations is false (default), any annotations added manually and the SofA they may refer to, will be preserved.
• abstract classmethod SortBegin() as %Status
• abstract classmethod SortEnd() as %Status