org.apache.ctakes.core.util

Class DocumentIDAnnotationUtil

java.lang.Object

org.apache.ctakes.core.util.DocumentIDAnnotationUtil

public final class DocumentIDAnnotationUtil
extends Object

Utility class for fetching document id

Field Summary

Fields

Modifier and Type	Field and Description
static String	NO_DOCUMENT_ID

Method Summary

Modifier and Type	Method and Description
static String	getDeepDocumentId(org.apache.uima.jcas.JCas startingJcas) Gets the document Id by progressing through 3 layers until an Id is found: starting JCas, Initial View, Plaintext View
static String	getDocumentID(org.apache.uima.jcas.JCas jcas) Check the jcas for a document id.
static String	getDocumentIdForFile(org.apache.uima.jcas.JCas jcas) Create a unique id for the document that can be used for an output filename or url.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NO_DOCUMENT_ID

public static final String NO_DOCUMENT_ID

See Also:

Constant Field Values

Method Detail

getDocumentID

public static String getDocumentID(org.apache.uima.jcas.JCas jcas)

Check the jcas for a document id. Unlike getDeepDocumentId(JCas), this method does not progress into deeper jcas layers/views.

Parameters:

jcas - ye olde ...

Returns:

the document id contained in the type "DocumentID" or NO_DOCUMENT_ID

getDeepDocumentId

public static String getDeepDocumentId(org.apache.uima.jcas.JCas startingJcas)

Gets the document Id by progressing through 3 layers until an Id is found: starting JCas, Initial View, Plaintext View

Parameters:

startingJcas - initial JCas to start the checking

Returns:

Document Id from the starting JCas, the Initial View, the Plaintext View, or NO_DOCUMENT_ID

getDocumentIdForFile

public static String getDocumentIdForFile(org.apache.uima.jcas.JCas jcas)

Create a unique id for the document that can be used for an output filename or url. Will be the source document file name if possible, otherwise the first 10 characters of the text plus text hashcode, or "Unknown_" and the current millis if there is no text. Non-alphanumeric characters are replaced with '_'.

Parameters:

jcas - -

Returns:

an ok document id