edu.mit.jwi.data.compare

Class SenseKeyLineComparator

java.lang.Object

edu.mit.jwi.data.compare.SenseKeyLineComparator

All Implemented Interfaces:

ILineComparator, Comparator<String>

public class SenseKeyLineComparator
extends Object
implements ILineComparator

A comparator that captures the ordering of lines in sense index files (e.g., the sense.index file). This files are ordered alphabetically by sense key.

This class follows a singleton design pattern, and is not intended to be instantiated directly; rather, call the getInstance() method to get the singleton instance.

Since:

JWI 2.1.0

Version:

2.4.0

Author:

Mark A. Finlayson

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SenseKeyLineComparator() This constructor is marked protected so that the class may be sub-classed, but not directly instantiated.

Method Summary

Modifier and Type	Method and Description
int	compare(String line1, String line2)
ICommentDetector	getCommentDetector() Returns the comment detector instance associated with this line comparator, or null if one does not exist.
static SenseKeyLineComparator	getInstance() Returns the singleton instance of this class, instantiating it if necessary.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Constructor Detail

SenseKeyLineComparator

protected SenseKeyLineComparator()

This constructor is marked protected so that the class may be sub-classed, but not directly instantiated. Obtain instances of this class via the static getInstance() method.

Since:

JWI 2.1.0

Method Detail

getInstance

public static SenseKeyLineComparator getInstance()

Returns the singleton instance of this class, instantiating it if necessary. The singleton instance will not be null.

Returns:

the non-null singleton instance of this class, instantiating it if necessary.

Since:

JWI 2.1.0

compare

public int compare(String line1,
                   String line2)

Specified by:

compare in interface Comparator<String>

getCommentDetector

public ICommentDetector getCommentDetector()

Description copied from interface: ILineComparator

Returns the comment detector instance associated with this line comparator, or null if one does not exist.

Specified by:

getCommentDetector in interface ILineComparator

Returns:

the comment detector associated with this line comparator, or null if there is none