org.apache.ctakes.core.util

Class SourceMetadataUtil

java.lang.Object

org.apache.ctakes.core.util.SourceMetadataUtil

public final class SourceMetadataUtil
extends Object

Utility class with convenience methods for a few commonly-used JCas Metadata types that are begged of the source

Since:

1/8/2015

Version:

%I%

Author:

SPF , chip-nlp

Method Summary

Modifier and Type	Method and Description
static int	getEncounterNum(SourceData sourcedata)
static long	getInstanceNum(SourceData sourcedata)
static long	getPatientNum(org.apache.uima.jcas.JCas jcas)
static String	getProviderId(SourceData sourcedata)
static SourceData	getSourceData(org.apache.uima.jcas.JCas jcas) The first step in utilizing SourceData is getting it!
static Timestamp	getStartDate(SourceData sourcedata)

Methods inherited from class java.lang.Object

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

Method Detail

getPatientNum

public static long getPatientNum(org.apache.uima.jcas.JCas jcas)

Parameters:

jcas - ye olde jay-cas

Returns:

the patient id for the source or -1 if one is not found

getSourceData

public static SourceData getSourceData(org.apache.uima.jcas.JCas jcas)

The first step in utilizing SourceData is getting it!

Parameters:

jcas - ye olde jay-cas

Returns:

the metadata for the source associated with the jcas or null if one is not found

getInstanceNum

public static long getInstanceNum(SourceData sourcedata)
                           throws org.apache.uima.resource.ResourceProcessException

Parameters:

sourcedata - -

Returns:

the instance id or -1 if there isn't one

Throws:

org.apache.uima.resource.ResourceProcessException - if the internal value is not parseable as long

getEncounterNum

public static int getEncounterNum(SourceData sourcedata)
                           throws org.apache.uima.resource.ResourceProcessException

Parameters:

sourcedata - -

Returns:

the encounter id

Throws:

org.apache.uima.resource.ResourceProcessException - if the encounter id does not exist or is not parseable as an int

getProviderId

public static String getProviderId(SourceData sourcedata)

Parameters:

sourcedata - -

Returns:

the author specialty

getStartDate

public static Timestamp getStartDate(SourceData sourcedata)

Parameters:

sourcedata - -

Returns:

the original date for the source