View (illinois-cogcomp-nlp 3.1.29 API)

java.lang.Object
- edu.illinois.cs.cogcomp.core.datastructures.textannotation.View

All Implemented Interfaces:

IQueryable<Constituent>, Serializable, Iterable<Constituent>

Direct Known Subclasses:

CoreferenceView, PredicateArgumentView, SpanLabelView, TreeView
```
public class View
extends Object
implements Serializable, IQueryable<Constituent>
```
This class represents a view of the text. According to the multi-view architecture, any annotation on text can be thought of as a graph, where each node in the graph may correspond to sets of tokens in the text. Labeled directed edges between the nodes denote relations.
The nodes are objects of type Constituent and the edges are objects of type Relation.

This class represents a generic view without any restrictions on the structure of the graph and can be used for general purpose application specific views. However, for most standard annotations can be represented as one of the sub-classes of this class.

Author:

Vivek Srikumar

See Also:

Constituent, Relation, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected QueryableList<Constituent>`	`constituents` The collection of constituents
`protected int`	`endSpan` The token id of the token next to the rightmost token in this view.
`protected QueryableList<Relation>`	`relations` The collection of relations in this view.
`protected double`	`score` The score of this view, which is generated by the system that annotates this view.
`protected int`	`startSpan` The token id of the leftmost token in this view.
`protected TextAnnotation`	`textAnnotation` The TextAnnotation that is annotated by this view.
`protected ArrayList[]`	`tokensToConstituents` A inverted index from token ids to constituents in this view that cover that token.
`protected String`	`viewGenerator` The name of the system that generates this view.
`protected String`	`viewName` The name of this view.

Constructor Summary

Constructors
Constructor and Description
`View(String viewName, String viewGenerator, TextAnnotation text, double score)` Creates a view for `text` called `viewName` which is created using a view generator called `ViewGenerator` and is assigned a score `score`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addConstituent(Constituent constituent)` Adds a new constituent to this view
`void`	`addRelation(Relation relation)` Adds a new relation to this view.
`boolean`	`containsConstituent(Constituent c)` Checks if this view contains a constituent
`int`	`count()` Get the number of records in this iterator.
`List<Constituent>`	`getConstituents()` Returns the constituents contained in this view.
`List<Constituent>`	`getConstituentsCovering(Constituent c)` Get the constituents which cover the input constituent `c`.
`List<Constituent>`	`getConstituentsCoveringCharSpan(int charStart, int charEnd)` Given char-begin-offset and char-end-offset, it returns the constituents covering it.
`List<Constituent>`	`getConstituentsCoveringSpan(int start, int end)`
`List<Constituent>`	`getConstituentsCoveringToken(int tokenId)`
`List<Constituent>`	`getConstituentsCoveringTokens(Collection<Integer> tokenIds)`
`List<Constituent>`	`getConstituentsOverlappingCharSpan(int charStart, int charEnd)` Given char-begin-offset and char-end-offset, it returns the constituents with some overlap with the input char offsets.
`List<Constituent>`	`getConstituentsWithSpan(IntPair span)`
`int`	`getEndSpan()`
`protected Set<Constituent>`	`getFilteredConstituents(Predicate<Constituent> predicate)`
`List<String>`	`getLabelsCovering(Constituent c)` Get the labels of the constituents covered by the input constituent `c`
`List<String>`	`getLabelsCoveringSpan(int start, int end)`
`List<String>`	`getLabelsCoveringToken(int tokenId)`
`List<String>`	`getLabelsCoveringTokens(Collection<Integer> tokenIds)`
`int`	`getNumberOfConstituents()`
`List<Relation>`	`getRelations()`
`View`	`getRestrictedView(Predicate<Constituent> constituentPredicate, ITransformer<View,Double> scoreTransformer)`
`double`	`getScore()`
`int`	`getStartSpan()`
`TextAnnotation`	`getTextAnnotation()`
`View`	`getViewCoveringSpan(int start, int end, ITransformer<View,Double> scoreTransformer)`
`View`	`getViewCoveringToken(int token, ITransformer<View,Double> scoreTransformer)`
`View`	`getViewCoveringTokens(Collection<Integer> tokens, ITransformer<View,Double> scoreTransformer)`
`String`	`getViewGenerator()`
`String`	`getViewName()`
`Iterator<Constituent>`	`iterator()`
`IQueryable<Constituent>`	`orderBy(Comparator<Constituent> comparator)` Returns a queryable iterator, where the elements of this iterator are sorted using the comparator.
`void`	`removeAllConsituents()`
`void`	`removeAllRelations()`
`void`	`removeAttributes()` Removes all the attributes from the constituents of this of this view
`void`	`removeConstituent(Constituent constituent)` Removes a constituent from this view.
`void`	`removeRelation(Relation relation)` removes a relation from this view.
`<S> IQueryable<S>`	`select(ITransformer<Constituent,S> transformer)` Given a transformer that converts objects of type T to those of type S, this function returns a new queryable iterator, containing objects of type S which are created by applying the transformer to each element of this iterator.
`IQueryable<Constituent>`	`unique()` Get a queryable iterator containing the unique elements of this iterator.
`IQueryable<Constituent>`	`where(Predicate<Constituent> condition)` Get a queryable iterator that contains the elements of this iterator which satisfy the condition.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - viewName
```
protected final String viewName
```
    The name of this view. While this can be any arbitrary string, if the view represents a standard annotation, use one of the standard names from ViewNames.
  - score
```
protected final double score
```
    The score of this view, which is generated by the system that annotates this view.
  - textAnnotation
```
protected final TextAnnotation textAnnotation
```
    The TextAnnotation that is annotated by this view.
  - constituents
```
protected final QueryableList<Constituent> constituents
```
    The collection of constituents
  - relations
```
protected final QueryableList<Relation> relations
```
    The collection of relations in this view.
  - viewGenerator
```
protected final String viewGenerator
```
    The name of the system that generates this view.
  - tokensToConstituents
```
protected final ArrayList[] tokensToConstituents
```
    A inverted index from token ids to constituents in this view that cover that token.
    The first element corresponds to the token id, the second corresponds to the constituent .
  - startSpan
```
protected int startSpan
```
    The token id of the leftmost token in this view.
  - endSpan
```
protected int endSpan
```
    The token id of the token next to the rightmost token in this view.
- Constructor Detail
  - View
```
public View(String viewName,
            String viewGenerator,
            TextAnnotation text,
            double score)
```
    Creates a view for text called viewName which is created using a view generator called ViewGenerator and is assigned a score score
    
    Parameters:
    
    viewName - The name of this view
    
    viewGenerator - The source of this view
    
    text - The text annotation that this view annotates
    
    score - The score of this view
- Method Detail
  - addConstituent
```
public void addConstituent(Constituent constituent)
```
    Adds a new constituent to this view
    
    Parameters:
    
    constituent - The new constituent to be added.
  - removeConstituent
```
public void removeConstituent(Constituent constituent)
```
    Removes a constituent from this view. Removes any relations whose source or target was this constituent.
  - addRelation
```
public void addRelation(Relation relation)
```
    Adds a new relation to this view. This function throws an exception if the relation involves constituents that are not contained in this view. In order for a relation to be added, the constituents should have been added first. This function does not check for this.
    
    Parameters:
    
    relation - The relation to be added
  - removeRelation
```
public void removeRelation(Relation relation)
```
    removes a relation from this view.
  - removeAllRelations
```
public void removeAllRelations()
```
  - removeAllConsituents
```
public void removeAllConsituents()
```
  - removeAttributes
```
public void removeAttributes()
```
    Removes all the attributes from the constituents of this of this view
  - containsConstituent
```
public boolean containsConstituent(Constituent c)
```
    Checks if this view contains a constituent
    
    Parameters:
    
    c - The constituent, whose containership needs to be checked.
    
    Returns:
    
    true if this view contains the constituent
  - getConstituents
```
public List<Constituent> getConstituents()
```
    Returns the constituents contained in this view.
    
    Returns:
    
    the constituents
  - getConstituentsCovering
```
public List<Constituent> getConstituentsCovering(Constituent c)
```
    Get the constituents which cover the input constituent c.
    
    Parameters:
    
    c - A constituent, not necessarily of this text annotation.
    
    Returns:
    
    A list of constituents, which cover the same tokens as the input
  - getLabelsCovering
```
public List<String> getLabelsCovering(Constituent c)
```
    Get the labels of the constituents covered by the input constituent c
    
    Parameters:
    
    c - A constituent, not necessarily of this text annotation.
    
    Returns:
    
    A list of labels of constituents, which cover the same tokens as the input
  - getLabelsCoveringSpan
```
public List<String> getLabelsCoveringSpan(int start,
                                          int end)
```
  - getLabelsCoveringTokens
```
public List<String> getLabelsCoveringTokens(Collection<Integer> tokenIds)
```
  - getLabelsCoveringToken
```
public List<String> getLabelsCoveringToken(int tokenId)
```
  - getConstituentsCoveringSpan
```
public List<Constituent> getConstituentsCoveringSpan(int start,
                                                     int end)
```
  - getConstituentsCoveringCharSpan
```
public List<Constituent> getConstituentsCoveringCharSpan(int charStart,
                                                         int charEnd)
```
    Given char-begin-offset and char-end-offset, it returns the constituents covering it.
    
    Parameters:
    
    charStart - the begin char index
    
    charEnd - the end char index (one-past-the-end indexing)
  - getConstituentsOverlappingCharSpan
```
public List<Constituent> getConstituentsOverlappingCharSpan(int charStart,
                                                            int charEnd)
```
    Given char-begin-offset and char-end-offset, it returns the constituents with some overlap with the input char offsets.
    
    Parameters:
    
    charStart - the begin char index
    
    charEnd - the end char index (one-past-the-end indexing)
  - getConstituentsWithSpan
```
public List<Constituent> getConstituentsWithSpan(IntPair span)
```
    Returns:
    
    all the constituents that have exact span start/end.
  - getConstituentsCoveringTokens
```
public List<Constituent> getConstituentsCoveringTokens(Collection<Integer> tokenIds)
```
  - getConstituentsCoveringToken
```
public List<Constituent> getConstituentsCoveringToken(int tokenId)
```
  - getEndSpan
```
public int getEndSpan()
```
  - getFilteredConstituents
```
protected Set<Constituent> getFilteredConstituents(Predicate<Constituent> predicate)
```
  - getNumberOfConstituents
```
public int getNumberOfConstituents()
```
  - getRelations
```
public List<Relation> getRelations()
```
    Returns:
    
    the relations
  - getRestrictedView
```
public View getRestrictedView(Predicate<Constituent> constituentPredicate,
                              ITransformer<View,Double> scoreTransformer)
```
  - getScore
```
public double getScore()
```
    Returns:
    
    the score
  - getStartSpan
```
public int getStartSpan()
```
  - getTextAnnotation
```
public TextAnnotation getTextAnnotation()
```
    Returns:
    
    the textAnnotation
  - getViewCoveringSpan
```
public View getViewCoveringSpan(int start,
                                int end,
                                ITransformer<View,Double> scoreTransformer)
```
  - getViewCoveringToken
```
public View getViewCoveringToken(int token,
                                 ITransformer<View,Double> scoreTransformer)
```
  - getViewCoveringTokens
```
public View getViewCoveringTokens(Collection<Integer> tokens,
                                  ITransformer<View,Double> scoreTransformer)
```
  - getViewName
```
public String getViewName()
```
    Returns:
    
    The name of this view. While this can be any arbitrary string, if the view represents a standard annotation, it is best to use one of the standard names from ViewNames.
  - getViewGenerator
```
public String getViewGenerator()
```
  - orderBy
```
public IQueryable<Constituent> orderBy(Comparator<Constituent> comparator)
```
    Description copied from interface: IQueryable
    
    Returns a queryable iterator, where the elements of this iterator are sorted using the comparator.
    
    Specified by:
    
    orderBy in interface IQueryable<Constituent>
    
    Parameters:
    
    comparator - The comparator for type T
    
    Returns:
    
    A sorted queryable iterator
  - select
```
public <S> IQueryable<S> select(ITransformer<Constituent,S> transformer)
```
    Description copied from interface: IQueryable
    
    Given a transformer that converts objects of type T to those of type S, this function returns a new queryable iterator, containing objects of type S which are created by applying the transformer to each element of this iterator.
    
    Specified by:
    
    select in interface IQueryable<Constituent>
    
    Type Parameters:
    
    S - The type of the elements of the returned iterator
    
    Parameters:
    
    transformer - An ITransformer that converts objects of type T to those of type S
    
    Returns:
    
    A queryable iterator containing objects of type S.
  - unique
```
public IQueryable<Constituent> unique()
```
    Description copied from interface: IQueryable
    
    Get a queryable iterator containing the unique elements of this iterator.
    
    Specified by:
    
    unique in interface IQueryable<Constituent>
  - where
```
public IQueryable<Constituent> where(Predicate<Constituent> condition)
```
    Description copied from interface: IQueryable
    
    Get a queryable iterator that contains the elements of this iterator which satisfy the condition.
    
    Specified by:
    
    where in interface IQueryable<Constituent>
    
    Parameters:
    
    condition - A Predicate, which takes an object of type T and returns true/false.
    
    Returns:
    
    A queryable iterator containing only those elements for which the condition is true.
  - iterator
```
public Iterator<Constituent> iterator()
```
    Specified by:
    
    iterator in interface Iterable<Constituent>
  - count
```
public int count()
```
    Description copied from interface: IQueryable
    
    Get the number of records in this iterator.
    
    Specified by:
    
    count in interface IQueryable<Constituent>

Class View

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

viewName

score

textAnnotation

constituents

relations

viewGenerator

tokensToConstituents

startSpan

endSpan

Constructor Detail

View

Method Detail

addConstituent

removeConstituent

addRelation

removeRelation

removeAllRelations

removeAllConsituents

removeAttributes

containsConstituent

getConstituents

getConstituentsCovering

getLabelsCovering

getLabelsCoveringSpan

getLabelsCoveringTokens

getLabelsCoveringToken

getConstituentsCoveringSpan

getConstituentsCoveringCharSpan

getConstituentsOverlappingCharSpan

getConstituentsWithSpan

getConstituentsCoveringTokens

getConstituentsCoveringToken

getEndSpan

getFilteredConstituents

getNumberOfConstituents

getRelations

getRestrictedView

getScore

getStartSpan

getTextAnnotation

getViewCoveringSpan

getViewCoveringToken

getViewCoveringTokens

getViewName

getViewGenerator

orderBy

select

unique

where

iterator

count