org.apache.ctakes.temporal.utils

Enum TlinkType

java.lang.Object

java.lang.Enum<TlinkType>

org.apache.ctakes.temporal.utils.TlinkType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TlinkType>

public enum TlinkType
extends java.lang.Enum<TlinkType>

Enumeration of the three temporal relation types used in THYME (before, overlap, contains) and their reciprocals (after, overlap, contained_by) Begins-on and Ends-on added 4-11-2013

Enum Constant Summary

Enum Constants

Enum Constant and Description
AFTER
BEFORE
BEGINS_ON
CONTAINED_BY
CONTAINS
ENDS_ON
OVERLAP

Field Summary

Fields

Modifier and Type	Field and Description
private int	_index
private static int[][]	TML_ABC_ARRAY

Method Summary

Methods

Modifier and Type	Method and Description
static TlinkType	getCombinedTypeConservative(TlinkType typeA, TlinkType typeB)
static TlinkType	getCombinedTypeLiberal(TlinkType typeA, TlinkType typeB)
private int	getIndex()
TlinkType	getReciprocal()
private static TlinkType	getTimeRelationType(int index)
static TlinkType	getTimeRelationType(long startA, long startB, long endA, long endB)
static TlinkType	getTimeRelationType(java.lang.String name)
TlinkType	getTimeRelationTypeAtoC(TlinkType tlinkTypeBtoC)
static TlinkType	getTlinkType(BinaryTextRelation tlink)
static TlinkType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TlinkType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BEFORE

public static final TlinkType BEFORE

AFTER

public static final TlinkType AFTER

OVERLAP

public static final TlinkType OVERLAP

CONTAINS

public static final TlinkType CONTAINS

CONTAINED_BY

public static final TlinkType CONTAINED_BY

BEGINS_ON

public static final TlinkType BEGINS_ON

ENDS_ON

public static final TlinkType ENDS_ON

Field Detail

TML_ABC_ARRAY

private static final int[][] TML_ABC_ARRAY

_index

private final int _index

Method Detail

values

public static TlinkType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TlinkType c : TlinkType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TlinkType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getTlinkType

public static TlinkType getTlinkType(BinaryTextRelation tlink)

getTimeRelationType

public static TlinkType getTimeRelationType(java.lang.String name)

getTimeRelationType

public static TlinkType getTimeRelationType(long startA,
                            long startB,
                            long endA,
                            long endB)

getCombinedTypeConservative

public static TlinkType getCombinedTypeConservative(TlinkType typeA,
                                    TlinkType typeB)

getCombinedTypeLiberal

public static TlinkType getCombinedTypeLiberal(TlinkType typeA,
                               TlinkType typeB)

getTimeRelationType

private static TlinkType getTimeRelationType(int index)

getIndex

private int getIndex()

getTimeRelationTypeAtoC

public TlinkType getTimeRelationTypeAtoC(TlinkType tlinkTypeBtoC)

Parameters:

tlinkTypeBtoC - a relation with a start argument coincidental with this relation

Returns:

for this relation A to B and the given relation B to C, return relation A to C

getReciprocal

public TlinkType getReciprocal()

Returns:

the reciprocal Temporal Relation type of (this) relation type