edu.mit.jwi.data.compare

Class IndexLineComparator

java.lang.Object

edu.mit.jwi.data.compare.IndexLineComparator

All Implemented Interfaces:

ILineComparator, Comparator<String>

public class IndexLineComparator
extends Object
implements ILineComparator

A comparator that captures the ordering of lines in Wordnet index files (e.g., index.adv or adv.idx files). These files are ordered alphabetically.

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 1.0

Version:

2.4.0

Author:

Mark A. Finlayson

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IndexLineComparator(CommentComparator detector) 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 s1, String s2)
ICommentDetector	getCommentDetector() Returns the comment detector instance associated with this line comparator, or null if one does not exist.
static IndexLineComparator	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

IndexLineComparator

protected IndexLineComparator(CommentComparator detector)

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.

Parameters:

detector - the comment detector for this line comparator, or null if there is none

Throws:

NullPointerException - if the specified comment comparator is null

Since:

JWI 1.0

Method Detail

getInstance

public static IndexLineComparator 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.0.0

compare

public int compare(String s1,
                   String s2)

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