edu.mit.jmwe.data.concordance

Class TaggedConcordanceIterator

java.lang.Object

edu.mit.jmwe.data.concordance.TaggedConcordanceIterator

All Implemented Interfaces:

java.util.Iterator<IConcordanceSentence>

public class TaggedConcordanceIterator
extends java.lang.Object
implements java.util.Iterator<IConcordanceSentence>

An iterator over a list of tagged concodrance sentences. This iterator does not support the remove() operation. Each tagged sentence must be on its own line, in the following format:

 concordanceName/contextID/sentNumber [tok_tag_stems_num_part]+
 

Since:

jMWE 1.0.0

Version:

$Id: TaggedConcordanceIterator.java 356 2015-11-25 22:36:46Z markaf $

Author:

M.A. Finlayson

See Also:

ConcordanceTagger

Field Summary

Fields

Modifier and Type	Field and Description
protected IConcordanceSentence	next
protected java.io.BufferedReader	source

Constructor Summary

Constructors

Constructor and Description
TaggedConcordanceIterator(java.io.File file) Constructs the iterator form the given source file.
TaggedConcordanceIterator(java.io.Reader r) Constructs the iterator from a reader.
TaggedConcordanceIterator(java.net.URL url) Constructs the iterator from a URL pointing to a list of tagged semcor sentences.

Method Summary

Modifier and Type	Method and Description
protected void	advance() Internal method used to advance the iterator to the next element in the list.
boolean	hasNext()
protected boolean	ignoreLine(java.lang.String line) Indicates whether the specified line is to be ignored.
IConcordanceSentence	next()
void	remove()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Field Detail

source

protected final java.io.BufferedReader source

next

protected IConcordanceSentence next

Constructor Detail

TaggedConcordanceIterator

public TaggedConcordanceIterator(java.io.File file)
                          throws java.io.IOException

Constructs the iterator form the given source file.

Parameters:

file - the source file of tagged sentences in the proper format.

Throws:

java.io.IOException - if an IOException occurs when opening or reading from the file.

Since:

jMWE 1.0.0

TaggedConcordanceIterator

public TaggedConcordanceIterator(java.net.URL url)
                          throws java.io.IOException

Constructs the iterator from a URL pointing to a list of tagged semcor sentences.

Parameters:

url - a url pointing to a list of tagged semcor sentences, may not be null

Throws:

java.lang.NullPointerException - if source is null

java.io.IOException - if an IOException occurs when opening or reading from the file.

Since:

jMWE 1.0.0

TaggedConcordanceIterator

public TaggedConcordanceIterator(java.io.Reader r)
                          throws java.io.IOException

Constructs the iterator from a reader.

Parameters:

r - the reader from which the data is read

Throws:

java.io.IOException - if there is an exception reading from the reader

java.lang.NullPointerException - if the reader is null

Since:

jMWE 1.0.0

Method Detail

next

public IConcordanceSentence next()

Specified by:

next in interface java.util.Iterator<IConcordanceSentence>

advance

protected void advance()
                throws java.io.IOException

Internal method used to advance the iterator to the next element in the list.

Throws:

java.io.IOException - if the reader reaches the end of the file (there are no elements left)

Since:

jMWE 1.0.0

ignoreLine

protected boolean ignoreLine(java.lang.String line)

Indicates whether the specified line is to be ignored. Lines where the first non-whitespace character is a double slash ('//') or double semicolon (';;') are considered comment lines, and will cause this method to return true. Lines consisting of all whitespace will also cause this method to return true. Otherwise, the method returns false.

Parameters:

line - the line being considered

Returns:

true if the line begins with a double slash, double semicolon or is all whitespace.

Since:

jMWE 1.0.0

hasNext

public boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator<IConcordanceSentence>

remove

public void remove()

Specified by:

remove in interface java.util.Iterator<IConcordanceSentence>