DeltaIndex (Stanford JavaNLP API)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

edu.stanford.nlp.util
Class DeltaIndex<E>

java.lang.Object
  java.util.AbstractCollection<E>
      edu.stanford.nlp.util.DeltaIndex<E>

All Implemented Interfaces:: Index<E>, java.io.Serializable, java.lang.Iterable<E>, java.util.Collection<E>

public class DeltaIndex<E>
extends java.util.AbstractCollection<E>
implements Index<E>
extends java.util.AbstractCollection<E>
implements Index<E>

A class that has a backing index, such as a hash index you don't want changed, and another index which will hold extra entries that get added during the life of the index.
It is important that nothing else changes the backing index while a DeltaIndex is in use. The behavior of this index is undefined if the backing index changes, although in general the new entries in the backing index will be ignored.

Author:: John Bauer
See Also:: Serialized Form

Constructor Summary
`DeltaIndex(Index<E> backingIndex)`
`DeltaIndex(Index<E> backingIndex, Index<E> spilloverIndex)`

Method Summary

boolean add(E e)

boolean addAll(java.util.Collection<? extends E> c)

void clear()
We don't want to change the backing index in any way, and "clear" would have to entail doing that, so we just throw an UnsupportedOperationException instead

boolean contains(java.lang.Object o)

E get(int i)
Gets the object whose index is the integer argument.

int indexOf(E o)
Returns the integer index of the Object in the Index or -1 if the Object is not already in the Index.

int indexOf(E o, boolean add)
Takes an Object and returns the integer index of the Object, perhaps adding it to the index first.

boolean isEmpty()

boolean isLocked()
Queries the Index for whether it's locked or not.

java.util.Iterator<E> iterator()
This is one instance where elements added to the backing index will show up in this index's operations

void lock()
Locks the Index.

java.util.Collection<E> objects(int[] indices)
Looks up the objects corresponding to an array of indices, and returns them in a Collection.

java.util.List<E> objectsList()
Returns a complete List of indexed objects, in the order of their indices.

void saveToFilename(java.lang.String s)
Save the contents of this index into a file.

void saveToWriter(java.io.Writer out)
Save the contents of this index into string form, as part of a larger text-serialization.

int size()
Returns the number of indexed objects.





<T> T[]

toArray(T[] a)

java.lang.String toString()
super ghetto

void unlock()
Unlocks the Index.

Methods inherited from class java.util.AbstractCollection
`containsAll, remove, removeAll, retainAll, toArray`

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

Methods inherited from interface java.util.Collection
`equals, hashCode`

Constructor Detail

DeltaIndex

public DeltaIndex(Index<E> backingIndex)

DeltaIndex

public DeltaIndex(Index<E> backingIndex,
                  Index<E> spilloverIndex)

Method Detail