be.yami

Class SequenceBuilder<S extends Sequence<E>,E extends SequenceEntry>

java.lang.Object

be.yami.SequenceBuilder<S,E>

Type Parameters:

S - The type of sequence to consider.

E - The type of entry in the sequence.

Direct Known Subclasses:

ApacheUserSessionBuilder, JsonMethodCallsSequenceBuilder

public abstract class SequenceBuilder<S extends Sequence<E>,E extends SequenceEntry>
extends Object

Represents an abstract SequenceBuilder. This object encapsulates methods to manage the building, filtering and dispatching the sequences get from an InputStream. The filtering is done using include and exclude EntryFilters and the processing is delegated to registered listeners.

Author:

Xavier Devroey - xavier.devroey@unamur.be

Constructor Summary

Constructors

Constructor and Description
SequenceBuilder() Creates a new user session builder.

Method Summary

Modifier and Type	Method and Description
SequenceBuilder<S,E>	addListener(SequenceProcessor<S> listener) Add a listener notified when a session is built (during buildSession call).
abstract void	buildSessions(InputStream input) Build the sequences from the different entry of the InputStream.
SequenceBuilder<S,E>	exclude(EntryFilter<E> filter) Add an include filter to this builder.
SequenceBuilder<S,E>	include(EntryFilter<E> filter) Add an include filter to this builder.
protected boolean	isAcceptedEntry(E req) Check if the entry is accepted according to the include and exclude filters.
protected void	sequenceCompleted(S sequence) Notifies the listeners that the given session has been built.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SequenceBuilder

public SequenceBuilder()

Creates a new user session builder.

Method Detail

addListener

public SequenceBuilder<S,E> addListener(SequenceProcessor<S> listener)

Add a listener notified when a session is built (during buildSession call).

Parameters:

listener - The listener to add.

Returns:

This object.

sequenceCompleted

protected void sequenceCompleted(S sequence)

Notifies the listeners that the given session has been built.

Parameters:

sequence - The sequence given to the listeners.

include

public SequenceBuilder<S,E> include(EntryFilter<E> filter)

Add an include filter to this builder. Only entries satisfying all the include filters are added to sequences.

Parameters:

filter - The filter to add

Returns:

This object.

exclude

public SequenceBuilder<S,E> exclude(EntryFilter<E> filter)

Add an include filter to this builder. Only entries that does not satisfy all the exclude filters are added to sequences.

Parameters:

filter - The filter to add

Returns:

This object.

isAcceptedEntry

protected boolean isAcceptedEntry(E req)

Check if the entry is accepted according to the include and exclude filters.

Parameters:

req - The entry to process.

Returns:

True if the entry satisfy all the include filters and does not satisfy all the exclude filters.

buildSessions

public abstract void buildSessions(InputStream input)
                            throws SessionBuildException

Build the sequences from the different entry of the InputStream. Each time a sequence is built, the listeners are notified. All the entries in the builded sequence satisfy isAcceptedEntry(Entry).

Parameters:

input - The InputStream to read.

Throws:

SessionBuildException - If an exception occurs during the building of the sessions.