com.jalios.jcms.analytics.storage

Class AbstractEventDataProvider

java.lang.Object

com.jalios.jcms.analytics.storage.AbstractEventDataProvider

All Implemented Interfaces:

java.lang.Iterable<EventData>

Direct Known Subclasses:

FileSystemEventDataProvider

public abstract class AbstractEventDataProvider
extends java.lang.Object
implements java.lang.Iterable<EventData>

Constructor Summary

Constructors

Constructor and Description
AbstractEventDataProvider()

Method Summary

Modifier and Type	Method and Description
abstract void	close() Close the AbstractEventDataProvider
abstract java.lang.String	getConfiguration() display String describing th AbstractEventDataProvider
abstract long	getMaxLength() Returns the maxLength of the inputStream
abstract long	getStatus(boolean absolute, boolean done) Return the status of the stream.

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, iterator, spliterator

Constructor Detail

AbstractEventDataProvider

public AbstractEventDataProvider()

Method Detail

getStatus

public abstract long getStatus(boolean absolute,
                               boolean done)

Return the status of the stream. How many bytes have been read.

Parameters:

absolute - if return an absolute value or percentage

done - if return the available byte or done bytes

Returns:

long the status of the stream

getMaxLength

public abstract long getMaxLength()

Returns the maxLength of the inputStream

Returns:

the maxLength of the inputStream

close

public abstract void close()
                    throws StorageException

Close the AbstractEventDataProvider

Throws:

StorageException

getConfiguration

public abstract java.lang.String getConfiguration()

display String describing th AbstractEventDataProvider