Class AllenRelation

java.lang.Object

org.aksw.commons.algebra.allen.AllenRelation

public class AllenRelation
extends Object

An immutable wrapper for a bit-pattern (of primitive type 'short') that represents the Allen relations

Field Summary

Fields

Modifier and Type	Field	Description
static final AllenRelation	AFTER
static final AllenRelation	BEFORE
static final AllenRelation	CONTAINS
static final AllenRelation	DURING
static final AllenRelation	EMPTY	Dummy relation with a 0 bit pattern.
static final AllenRelation	EQUALS
static final AllenRelation	FINISHEDBY
static final AllenRelation	FINISHES
static final AllenRelation	MEETS
static final AllenRelation	METBY
static final AllenRelation	OVERLAPPEDBY
static final AllenRelation	OVERLAPS
protected final short	pattern
static final AllenRelation	STARTEDBY
static final AllenRelation	STARTS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AllenRelation(short pattern)	The public API to create instances is invalid reference #create(short) .

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
short	getPattern()
int	hashCode()
AllenRelation	invert()	Create a new relation with the inverse
boolean	isEmpty()
static AllenRelation	of(short pattern)
static AllenRelation	of(short pattern, short... additionalPatterns)	Combine all given patterns with bitwise OR
String	toString()
AllenRelation	union(AllenRelation other)
static AllenRelation	union(AllenRelation... others)

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

EMPTY

public static final AllenRelation EMPTY

Dummy relation with a 0 bit pattern. Useful for reduce/fold operations.

BEFORE

public static final AllenRelation BEFORE

AFTER

public static final AllenRelation AFTER

DURING

public static final AllenRelation DURING

CONTAINS

public static final AllenRelation CONTAINS

OVERLAPS

public static final AllenRelation OVERLAPS

OVERLAPPEDBY

public static final AllenRelation OVERLAPPEDBY

MEETS

public static final AllenRelation MEETS

METBY

public static final AllenRelation METBY

STARTS

public static final AllenRelation STARTS

STARTEDBY

public static final AllenRelation STARTEDBY

FINISHES

public static final AllenRelation FINISHES

FINISHEDBY

public static final AllenRelation FINISHEDBY

EQUALS

public static final AllenRelation EQUALS

pattern

protected final short pattern

Constructor Details

AllenRelation

protected AllenRelation(short pattern)

The public API to create instances is

invalid reference

#create(short)

.

Method Details

getPattern

public short getPattern()

invert

public AllenRelation invert()

Create a new relation with the inverse

of

public static AllenRelation of(short pattern)

isEmpty

public boolean isEmpty()

of

public static AllenRelation of(short pattern,
 short... additionalPatterns)

Combine all given patterns with bitwise OR

union

public AllenRelation union(AllenRelation other)

union

public static AllenRelation union(AllenRelation... others)

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object