edu.washington.cs.knowitall.sequence.LayeredSequence Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of reverb-core Show documentation

A regular-expression based Open IE relation extractor.

There is a newer version: 1.4.3

package edu.washington.cs.knowitall.sequence;

import java.util.Collection;

/***
 * Represents a layered sequence of strings. An example of a layered sequence is
 * a POS-tagged sentence, which has a word layer, and a POS tag layer.
 * 
 * This interface defines the basic functionality expected from a layered
 * sequence, namely the ability to access the value of the sequence at a given
 * index of the given layer.
 * 
 * @author afader
 * 
 */
public interface LayeredSequence {

    /**
     * @param layerName
     * @param index
     * @return the value at the given position.
     * @throws IndexOutOfBoundsException
     *             if the index is out of range
     * @throws IllegalArgumentException
     *             if a layer with name layerName does not exist
     */
    public String get(String layerName, int index);

    /**
     * @return the layer names
     */
    public Collection getLayerNames();

    /**
     * @param layerName
     * @return true if this sequence has a layer with the given name
     */
    public boolean hasLayer(String layerName);

    /**
     * @return the number of layers
     */
    public int getNumLayers();

    /**
     * @return the length of the sequence
     */
    public int getLength();

}