Striterator (Blazegraph Database Platform 2.1.5 API)

java.lang.Object
- cutthecrap.utils.striterators.Striterator

All Implemented Interfaces:

ICloseable, ICloseableIterator, IStriterator, IStriterator.ITailOp, Enumeration, Iterator

Direct Known Subclasses:

XPropertyIterator
```
public class Striterator
extends Object
implements IStriterator, IStriterator.ITailOp, ICloseableIterator
```
Striterator - transformation and mapping patterns over java Iterator s.
Allows wrapping of an iterator so that extensions may add type specific next methods.
The IFilter objects passed to addFilter allow selection criteria for the iterated objects. The addTypeFilter method allows easy specification of a class type restriction.

Nested Class Summary
- Nested classes/interfaces inherited from interface cutthecrap.utils.striterators.IStriterator
  IStriterator.ITailOp

Constructor Summary

Constructors
Constructor and Description
`Striterator()` Deserialization constructor.
`Striterator(Enumeration src)`
`Striterator(Iterator src)` Constructor takes source iterator
`Striterator(Iterator src, List<IFilter> filters)`

Method Summary

Methods
Modifier and Type	Method and Description
`IStriterator`	`addFilter(IFilter filter)` creates a Filterator to apply the filter
`IStriterator`	`addInstanceOfFilter(Class cls)` check each object against cls.isInstance(object)
`IStriterator`	`addTypeFilter(Class cls)` check each object against cls.isInstance(object)
`IStriterator`	`append(Iterator iter)` append the iteration
`Iterator`	`availableTailOp()` If this Striterator has not been overriden then return the source iterator, or even better, try and recurse to the nested tailOp if available.
`void`	`close()` The base close implementation ends the iteration with no other side-effects.
`void`	`compile(Iterator src)`
`void`	`compile(Iterator src, Object context)`
`IStriterator`	`exclude(Object object)` exclude the object from the iteration
`boolean`	`hasMoreElements()` Enumeration version of hasNext()
`boolean`	`hasNext()` delegates hasNext request to source iterator
`IStriterator`	`makeUnique()` exclude the object from the iteration
`IStriterator`	`map(Object client, Method method)` map the clients method against the Iteration, the Method MUST take a single Object valued parameter
`Object`	`next()` delegates next request to source iterator
`Object`	`nextElement()` Enumeration version of next()
`void`	`remove()` delegates remove request to source iterator
`String`	`toString()` Human readable representation of the filter chain.

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

- Constructor Detail
  - Striterator
```
public Striterator()
```
    Deserialization constructor.
  - Striterator
```
public Striterator(Iterator src)
```
    Constructor takes source iterator
  - Striterator
```
public Striterator(Enumeration src)
```
  - Striterator
```
public Striterator(Iterator src,
           List<IFilter> filters)
```
    Parameters:
    src -
    filters -
- Method Detail
  - hasNext
```
public boolean hasNext()
```
    delegates hasNext request to source iterator
    
    Specified by:
    
    hasNext in interface Iterator
  - next
```
public Object next()
```
    delegates next request to source iterator
    
    Specified by:
    
    next in interface Iterator
  - hasMoreElements
```
public boolean hasMoreElements()
```
    Enumeration version of hasNext()
    
    Specified by:
    
    hasMoreElements in interface Enumeration
  - nextElement
```
public Object nextElement()
```
    Enumeration version of next()
    
    Specified by:
    
    nextElement in interface Enumeration
  - remove
```
public void remove()
```
    delegates remove request to source iterator
    
    Specified by:
    
    remove in interface Iterator
  - addFilter
```
public IStriterator addFilter(IFilter filter)
```
    creates a Filterator to apply the filter
    
    Specified by:
    
    addFilter in interface IStriterator
  - compile
```
public void compile(Iterator src)
```
  - compile
```
public void compile(Iterator src,
           Object context)
```
  - addTypeFilter
```
public IStriterator addTypeFilter(Class cls)
```
    check each object against cls.isInstance(object)
    
    Specified by:
    
    addTypeFilter in interface IStriterator
  - addInstanceOfFilter
```
public IStriterator addInstanceOfFilter(Class cls)
```
    check each object against cls.isInstance(object)
    
    Specified by:
    
    addInstanceOfFilter in interface IStriterator
  - exclude
```
public IStriterator exclude(Object object)
```
    exclude the object from the iteration
    
    Specified by:
    
    exclude in interface IStriterator
  - makeUnique
```
public IStriterator makeUnique()
```
    exclude the object from the iteration
    
    Specified by:
    
    makeUnique in interface IStriterator
  - append
```
public IStriterator append(Iterator iter)
```
    append the iteration
    
    Specified by:
    
    append in interface IStriterator
  - map
```
public IStriterator map(Object client,
               Method method)
```
    map the clients method against the Iteration, the Method MUST take a single Object valued parameter
    
    Specified by:
    
    map in interface IStriterator
  - toString
```
public String toString()
```
    Human readable representation of the filter chain.
    
    Overrides:
    
    toString in class Object
  - availableTailOp
```
public Iterator availableTailOp()
```
    If this Striterator has not been overriden then return the source iterator, or even better, try and recurse to the nested tailOp if available. This has been disabled since it appears to have a negative effect. To reactivate, uncomment the ITailOp implementation declaration. TODO: Investigate apparent performance degradation with activation
    
    Specified by:
    
    availableTailOp in interface IStriterator.ITailOp
    
    Returns:
  - close
```
public void close()
```
    The base close implementation ends the iteration with no other side-effects. Users should override this method for any required side-effects but must also invoke this "super" method.
    
    Specified by:
    
    close in interface ICloseable
    
    Specified by:
    
    close in interface ICloseableIterator

Class Striterator

Nested Class Summary

Nested classes/interfaces inherited from interface cutthecrap.utils.striterators.IStriterator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Striterator

Striterator

Striterator

Striterator

Method Detail

hasNext

next

hasMoreElements

nextElement

remove

addFilter

compile

compile

addTypeFilter

addInstanceOfFilter

exclude

makeUnique

append

map

toString

availableTailOp

close