SMILA (incubation) API documentation

org.eclipse.smila.bulkbuilder.outputs
Class BulkOutput

java.lang.Object
  extended by org.eclipse.smila.bulkbuilder.outputs.BulkOutput
Direct Known Subclasses:
AppendableBulkOutput

public abstract class BulkOutput
extends java.lang.Object

base class. for bulk output.


Field Summary
protected  Output _bulk
          bulk writer.
 
Constructor Summary
BulkOutput(java.lang.String jobName, java.lang.String bulkId, BulkType bulkType)
          create instance.
 
Method Summary
abstract  void addRecord(Record record)
          put a record to the bulk.
 void commit()
          committing the output.
 Output getBulk()
           
 long getBulkSizeLimit()
           
 long getBulkStartTime()
           
 BulkType getBulkType()
           
abstract  long getBytesWritten()
          get the number of bytes written.
 long getCommitTimeout()
           
 java.lang.String getCurrentBulkId()
           
 java.lang.String getJobName()
           
 long getLastModificationTime()
           
 IODataObject getOutput()
          access output object.
 boolean hasGrownBeyondLimit()
           
 boolean isTimedOut()
           
 void setBulk(Output bulk)
           
 void setBulkSizeLimit(long bulkSizeLimit)
          Set the bulk size limit (in bytes).
 void setCommitTimeout(long commitTimeout)
           
 void setCurrentBulkId(java.lang.String currentBulkId)
           
 void setLastModificationTime(long lastModificationTime)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_bulk

protected Output _bulk
bulk writer.

Constructor Detail

BulkOutput

public BulkOutput(java.lang.String jobName,
                  java.lang.String bulkId,
                  BulkType bulkType)
create instance.

Method Detail

getJobName

public java.lang.String getJobName()
Returns:
the job name.

getCurrentBulkId

public java.lang.String getCurrentBulkId()
Returns:
the current bulk id.

setCurrentBulkId

public void setCurrentBulkId(java.lang.String currentBulkId)
Parameters:
currentBulkId - the current bulk id.

getBulkType

public BulkType getBulkType()
Returns:
the bulk type.

getBulk

public Output getBulk()
Returns:
the bulk.

setBulk

public void setBulk(Output bulk)
Parameters:
bulk - output bulk to set.

getBulkStartTime

public long getBulkStartTime()
Returns:
the bulk start time.

getLastModificationTime

public long getLastModificationTime()
Returns:
the last modification time.

setLastModificationTime

public void setLastModificationTime(long lastModificationTime)
Parameters:
lastModificationTime - the last modification time to set.

getCommitTimeout

public long getCommitTimeout()
Returns:
the commit timeout in ms.

isTimedOut

public boolean isTimedOut()
Returns:
true if the bulk has timed out (if a timeout is set).

setCommitTimeout

public void setCommitTimeout(long commitTimeout)
Parameters:
commitTimeout - the commit timeout (in ms) to set.

setBulkSizeLimit

public void setBulkSizeLimit(long bulkSizeLimit)
Set the bulk size limit (in bytes).

Parameters:
bulkSizeLimit -

getBulkSizeLimit

public long getBulkSizeLimit()
Returns:
the bulk size limit (in bytes).

hasGrownBeyondLimit

public boolean hasGrownBeyondLimit()
Returns:
true if the bulk has grown beyond its limit (if any).

commit

public void commit()
            throws BulkbuilderException
committing the output.

Throws:
java.io.IOException
ObjectStoreException
BulkbuilderException

getOutput

public IODataObject getOutput()
access output object.


addRecord

public abstract void addRecord(Record record)
                        throws BulkbuilderException
put a record to the bulk.

Throws:
BulkbuilderException

getBytesWritten

public abstract long getBytesWritten()
get the number of bytes written.


SMILA (incubation) API documentation