FSVectorIndex (Apache UIMA Java SDK: uimaj 2.7.0 API)

java.lang.Object
- org.apache.uima.cas.impl.FSLeafIndexImpl<T>
- - org.apache.uima.cas.impl.FSVectorIndex<T>

All Implemented Interfaces:

Iterable<T>, FSIndex<T>, FSIndexImpl, LowLevelIndex, IntComparator
```
public class FSVectorIndex<T extends FeatureStructure>
extends FSLeafIndexImpl<T>
```

Field Summary
- Fields inherited from class org.apache.uima.cas.impl.FSLeafIndexImpl
  lowLevelCAS
- Fields inherited from interface org.apache.uima.cas.FSIndex
  BAG_INDEX, DEFAULT_BAG_INDEX, SET_INDEX, SORTED_INDEX

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`bulkAddTo(IntVector v)` For serialization: get all the items in this index and bulk add to an IntVector
`boolean`	`contains(FeatureStructure fs)` Check if the index contains an element equal to the given feature structure according to the comparators defined for this index.
`void`	`deleteFS(FeatureStructure fs)` Method deleteFS.
`FeatureStructure`	`find(FeatureStructure fs)` Find an entry in the index "equal to" the given feature structure according to the comparators specified for this index.
`void`	`flush()`
`boolean`	`insert(int fs)`
`LowLevelIterator`	`ll_iterator()` Get a low-level, FS reference iterator.
`ComparableIntPointerIterator`	`pointerIterator(IntComparator comp, int[] detectIllegalIndexUpdates, int typeCode)`
`protected IntPointerIterator`	`refIterator()`
`protected IntPointerIterator`	`refIterator(int fsCode)`
`int`	`size()` Return the number of feature structures in this index.

Methods inherited from class org.apache.uima.cas.impl.FSLeafIndexImpl
compare, compare, equals, getComparator, getIndexingStrategy, getIntIterator, getType, hashCode, iterator, iterator, ll_compare, ll_iterator, ll_rootIterator, toString, withSnapshotIterators

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

- Method Detail
  - flush
```
public void flush()
```
  - insert
```
public final boolean insert(int fs)
```
  - pointerIterator
```
public ComparableIntPointerIterator pointerIterator(IntComparator comp,
                                           int[] detectIllegalIndexUpdates,
                                           int typeCode)
```
    Specified by:
    
    pointerIterator in class FSLeafIndexImpl<T extends FeatureStructure>
  - refIterator
```
protected IntPointerIterator refIterator()
```
    Specified by:
    
    refIterator in class FSLeafIndexImpl<T extends FeatureStructure>
    
    See Also:
    FSLeafIndexImpl.refIterator()
  - refIterator
```
protected IntPointerIterator refIterator(int fsCode)
```
    Specified by:
    
    refIterator in class FSLeafIndexImpl<T extends FeatureStructure>
    
    See Also:
    FSLeafIndexImpl.refIterator(int)
  - contains
```
public boolean contains(FeatureStructure fs)
```
    Description copied from interface: FSIndex
    
    Check if the index contains an element equal to the given feature structure according to the comparators defined for this index. For bag indexes (which have no comparators), the equality test means the identical feature structure. Note that this is in general not the same as feature structure identity.
    
    Parameters:
    fs - A Feature Structure used a template to match for equality with the FSs in the index.
    
    Returns:
    true if the index contains such an element.
    See Also:
    FSIndex.contains(FeatureStructure)
  - find
```
public FeatureStructure find(FeatureStructure fs)
```
    Description copied from interface: FSIndex
    
    Find an entry in the index "equal to" the given feature structure according to the comparators specified for this index. Note that this is in general not the same as feature structure identity. For BAG indexes, it is identity, for others it means the found feature structure compares equal with the parameter in terms of the defined comparators for the index.
    
    Parameters:
    fs - A Feature Structure used a template to match with the Feature Structures in the index.
    
    Returns:
    A FS equal to the template argument, or null if no such FS exists.
    See Also:
    FSIterator.moveTo(FeatureStructure)
  - size
```
public int size()
```
    Description copied from interface: FSIndex
    
    Return the number of feature structures in this index.
    
    Returns:
    The number of FSs in this index.
    See Also:
    FSIndex.size()
  - deleteFS
```
public void deleteFS(FeatureStructure fs)
```
    Description copied from class: FSLeafIndexImpl
    
    Method deleteFS.
    
    Specified by:
    
    deleteFS in class FSLeafIndexImpl<T extends FeatureStructure>
    
    Parameters:
    fs - -
    See Also:
    FSLeafIndexImpl.deleteFS(org.apache.uima.cas.FeatureStructure)
  - ll_iterator
```
public LowLevelIterator ll_iterator()
```
    Description copied from interface: LowLevelIndex
    
    Get a low-level, FS reference iterator.
    
    Returns:
    An iterator for this index.
  - bulkAddTo
```
protected void bulkAddTo(IntVector v)
```
    Description copied from class: FSLeafIndexImpl
    
    For serialization: get all the items in this index and bulk add to an IntVector
    
    Specified by:
    
    bulkAddTo in class FSLeafIndexImpl<T extends FeatureStructure>

Class FSVectorIndex<T extends FeatureStructure>

Field Summary

Fields inherited from class org.apache.uima.cas.impl.FSLeafIndexImpl

Fields inherited from interface org.apache.uima.cas.FSIndex

Method Summary

Methods inherited from class org.apache.uima.cas.impl.FSLeafIndexImpl

Methods inherited from class java.lang.Object

Method Detail

flush

insert

pointerIterator

refIterator

refIterator

contains

find

size

deleteFS

ll_iterator

bulkAddTo