edu.mit.jwi.data.compare

Class CommentComparator

java.lang.Object

edu.mit.jwi.data.compare.CommentComparator

All Implemented Interfaces:

ICommentDetector, Comparator<String>

public class CommentComparator
extends Object
implements Comparator<String>, ICommentDetector

Default comment detector that is designed for comments found at the head of Wordnet dictionary files. It assumes that each comment line starts with two spaces, followed by a number that indicates the position of the comment line relative to the rest of the comment lines in the file.

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	CommentComparator() 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)
static CommentComparator	getInstance() Returns the singleton instance of this class, instantiating it if necessary.
boolean	isCommentLine(String line) Returns true if the specified string is a comment line, false otherwise.

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

CommentComparator

protected CommentComparator()

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.0.0

Method Detail

getInstance

public static CommentComparator 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>

isCommentLine

public boolean isCommentLine(String line)

Description copied from interface: ICommentDetector

Returns true if the specified string is a comment line, false otherwise.

Specified by:

isCommentLine in interface ICommentDetector

Parameters:

line - the line to be analyzed

Returns:

true if the specified string is a comment line, false otherwise.