eu.project.ttc.utils

Class TermOccurrenceUtils

java.lang.Object

eu.project.ttc.utils.TermOccurrenceUtils

public class TermOccurrenceUtils
extends java.lang.Object

A utililty class for TermOccurrence objects and collections.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Comparator<TermOccurrence>	uimaNaturalOrder

Constructor Summary

Constructors

Constructor and Description
TermOccurrenceUtils()

Method Summary

Modifier and Type	Method and Description
static boolean	areOffsetsOverlapping(TermOccurrence a, TermOccurrence b) True if two TermOccurrence offsets overlap strictly.
static boolean	areOverlapping(TermOccurrence a, TermOccurrence b) Returns true if two occurrences are in the same document and their offsets overlap.
static boolean	hasOverlappingOffsets(TermOccurrence theOcc, java.util.Collection<TermOccurrence> theOccCollection) True if an occurrence set contains any element overlapping with the param occurrence.
static void	markPrimaryOccurrence(java.util.Collection<TermOccurrence> occs, TermMeasure measure) Given a strategy, detects all primary occurrences in a collection of TermOccurrence.
static java.util.Iterator<java.util.List<TermOccurrence>>	occurrenceChunkIterator(java.util.Collection<TermOccurrence> occurrences) Returns a virtual iterator on chunks of an occurrence collection.
static void	removeOverlaps(java.util.Collection<TermOccurrence> referenceSet, java.util.Collection<TermOccurrence> occurrenceSet) Removes from an occurrence set all occurrences that overlap at least one occurrence in a reference occurrence set.

Methods inherited from class java.lang.Object

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

Field Detail

uimaNaturalOrder

public static java.util.Comparator<TermOccurrence> uimaNaturalOrder

Constructor Detail

TermOccurrenceUtils

public TermOccurrenceUtils()

Method Detail

markPrimaryOccurrence

public static void markPrimaryOccurrence(java.util.Collection<TermOccurrence> occs,
                                         TermMeasure measure)

Given a strategy, detects all primary occurrences in a collection of TermOccurrence. What defines an occurrence's primary/secondary status is the fact that in a Document, two primary occurrences cannot overlap. E.g. in text "offshore wind energy", the sequence or term occurrences "offshore" and "wind energy" is a set of primary sequence, but the set of term occurrences "offshore wind" and "wind energy" is not a primary sequence, because occurrences overlap.

Parameters:

occs - the occurrence collection

measure - the measure for detecting primary occurrences

See Also:

markPrimaryOccurrence(Collection, TermMeasure), TermOccurrence.isPrimaryOccurrence()

occurrenceChunkIterator

public static java.util.Iterator<java.util.List<TermOccurrence>> occurrenceChunkIterator(java.util.Collection<TermOccurrence> occurrences)

Returns a virtual iterator on chunks of an occurrence collection. A occurrence collection's chunk is a list of overlapping TermOccurrence. Every time there is a gap between two occurrences (i.e. there do not overlap), a new chunk is created.

Parameters:

occurrences -

Returns:

removeOverlaps

public static void removeOverlaps(java.util.Collection<TermOccurrence> referenceSet,
                                  java.util.Collection<TermOccurrence> occurrenceSet)

Removes from an occurrence set all occurrences that overlap at least one occurrence in a reference occurrence set.

Parameters:

referenceSet - the reference set, not modified by this method

occurrenceSet - the occurrence set to analyze, will be modified by this method

hasOverlappingOffsets

public static boolean hasOverlappingOffsets(TermOccurrence theOcc,
                                            java.util.Collection<TermOccurrence> theOccCollection)

True if an occurrence set contains any element overlapping with the param occurrence.

Parameters:

theOcc -

theOccCollection -

Returns:

areOffsetsOverlapping

public static boolean areOffsetsOverlapping(TermOccurrence a,
                                            TermOccurrence b)

True if two TermOccurrence offsets overlap strictly. Sharing exactly one offset (e.g. a.end == b.begin) is not considered as overlap.

Parameters:

a -

b -

Returns:

areOverlapping

public static boolean areOverlapping(TermOccurrence a,
                                     TermOccurrence b)

Returns true if two occurrences are in the same document and their offsets overlap.

Parameters:

a -

b -

Returns: