RecordRingItem

java.lang.Object
- org.jlab.coda.hipo.RecordRingItem

```
public class RecordRingItem
extends java.lang.Object
```
This class is used in conjunction with the RecordSupply class to provide a very fast supply of RecordOutputStream objects for reuse. Objects of this class are used to populate the ring buffer in RecordSupply and are simply a small wrapper around RecordOutputStream objects. Uses the Disruptor software package.

Since:

6.0 9/21/17

Version:

6.0

Author:

timmer

Constructor Summary

Constructors
Constructor and Description
`RecordRingItem(java.nio.ByteOrder order, int maxEventCount, int maxBufferSize, CompressionType compressionType)` Constructor.
`RecordRingItem(RecordRingItem item)` Copy constructor (sort of).

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`forceToDisk()` Get whether a file writer forces this record to be physically written to disk.
`void`	`forceToDisk(boolean force)` Set whether a file writer forces this record to be physically written to disk.
`void`	`fromConsumer(long seq, com.lmax.disruptor.Sequence seqObj)` Set the sequence of an item obtained through `RecordSupply.getToCompress(int)`.
`void`	`fromProducer(long seq)` Set the sequence of an item obtained through `RecordSupply.get()`.
`long`	`getId()` Get item's id.
`java.nio.ByteOrder`	`getOrder()` Get the byte order used to build record.
`RecordOutputStream`	`getRecord()` Get the contained record.
`long`	`getSequence()` Get the sequence at which this object was taken from ring by one of the "get" calls.
`com.lmax.disruptor.Sequence`	`getSequenceObj()` Get the Sequence object allowing ring consumer to get/release this item.
`boolean`	`isAlreadyReleased()` Has this item already been released by the RecordSupply?
`boolean`	`isCheckDisk()` Get whether there is not enough free space on the disk partition for the next, complete file to be written, resulting in not creating or writing to file.
`boolean`	`isLastItem()` Get whether this is the last item in the supply to be used.
`void`	`reset()` Method to reset this item each time it is retrieved from the supply.
`void`	`setAlreadyReleased(boolean released)` Set whether this item has already been released by the RecordSupply.
`void`	`setCheckDisk(boolean check)` Set whether there is not enough free space on the disk partition for the next, complete file to be written, resulting in not creating or writing to file.
`void`	`setId(long id)` Set this item's id number.
`void`	`setLastItem(boolean last)` Set whether this is the last item in the supply to be used.
`boolean`	`splitFileAfterWrite()` Get whether a file writer splits the file after writing this record.
`void`	`splitFileAfterWrite(boolean split)` Set whether a file writer splits the file after writing this record.

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

- Constructor Detail
  - RecordRingItem
```
RecordRingItem(java.nio.ByteOrder order,
               int maxEventCount,
               int maxBufferSize,
               CompressionType compressionType)
```
    Constructor.
    
    Parameters:
    
    order - byte order of built record byte arrays.
    
    maxEventCount - max number of events record can hold. Value <= O means use default (1M).
    
    maxBufferSize - max number of uncompressed data bytes record can hold. Value of < 8MB results in default of 8MB.
    
    compressionType - type of data compression to do.
  - RecordRingItem
```
public RecordRingItem(RecordRingItem item)
```
    Copy constructor (sort of). Used in EventWriter(Unsync) for when disk is full and a copy of the item to be written is made for later writing. Original item is released so ring can function. Note, not everything is copied (sequenceObj) since in usage, the original item has already been released. Also, alreadyReleased is true.
    Not to be used except internally by evio.
    
    Parameters:
    
    item - ring item to copy.
- Method Detail
  - reset
```
public void reset()
```
    Method to reset this item each time it is retrieved from the supply.
  - getRecord
```
public RecordOutputStream getRecord()
```
    Get the contained record. Record is reset.
    
    Returns:
    
    contained record.
  - getOrder
```
public java.nio.ByteOrder getOrder()
```
    Get the byte order used to build record.
    
    Returns:
    
    byte order used to build record.
  - getSequence
```
public long getSequence()
```
    Get the sequence at which this object was taken from ring by one of the "get" calls.
    
    Returns:
    
    sequence at which this object was taken from ring by one of the "get" calls.
  - getSequenceObj
```
public com.lmax.disruptor.Sequence getSequenceObj()
```
    Get the Sequence object allowing ring consumer to get/release this item.
    
    Returns:
    
    Sequence object allowing ring consumer to get/release this item.
  - fromProducer
```
public void fromProducer(long seq)
```
    Set the sequence of an item obtained through RecordSupply.get().
    
    Parameters:
    
    seq - sequence used to get item.
  - fromConsumer
```
public void fromConsumer(long seq,
                         com.lmax.disruptor.Sequence seqObj)
```
    Set the sequence of an item obtained through RecordSupply.getToCompress(int).
    
    Parameters:
    
    seq - sequence used to get item.
    
    seqObj - sequence object used to get/release item.
  - splitFileAfterWrite
```
public boolean splitFileAfterWrite()
```
    Get whether a file writer splits the file after writing this record.
    
    Returns:
    
    true if file writer splits the file after writing this record.
  - splitFileAfterWrite
```
public void splitFileAfterWrite(boolean split)
```
    Set whether a file writer splits the file after writing this record.
    
    Parameters:
    
    split - if true, file writer splits the file after writing this record, else false.
  - forceToDisk
```
public boolean forceToDisk()
```
    Get whether a file writer forces this record to be physically written to disk.
    
    Returns:
    
    true if file writer forces this record to be physically written to disk.
  - forceToDisk
```
public void forceToDisk(boolean force)
```
    Set whether a file writer forces this record to be physically written to disk.
    
    Parameters:
    
    force - if true, file writer forces this record to be physically written to disk, else false.
  - isCheckDisk
```
public boolean isCheckDisk()
```
    Get whether there is not enough free space on the disk partition for the next, complete file to be written, resulting in not creating or writing to file.
    
    Returns:
    
    true if there is not enough free space on the disk partition for the next, complete file to be written, resulting in not creating or writing to file.
  - setCheckDisk
```
public void setCheckDisk(boolean check)
```
    Set whether there is not enough free space on the disk partition for the next, complete file to be written, resulting in not creating or writing to file.
    
    Parameters:
    
    check - if true, there is not enough free space on the disk partition for the next, complete file to be written, resulting in not creating or writing to file.
  - isLastItem
```
public boolean isLastItem()
```
    Get whether this is the last item in the supply to be used.
    
    Returns:
    
    true this is the last item in the supply to be used.
  - setLastItem
```
public void setLastItem(boolean last)
```
    Set whether this is the last item in the supply to be used. Used in WriterMT when closing.
    
    Parameters:
    
    last - if true, this is the last item in the supply to be used.
  - isAlreadyReleased
```
public boolean isAlreadyReleased()
```
    Has this item already been released by the RecordSupply?
    
    Returns:
    
    true if item already been released by the RecordSupply.
  - setAlreadyReleased
```
public void setAlreadyReleased(boolean released)
```
    Set whether this item has already been released by the RecordSupply.
    
    Parameters:
    
    released - true if this item has already been released by the RecordSupply, else false.
  - getId
```
public long getId()
```
    Get item's id. Id is 0 if unused.
    
    Returns:
    
    id number.
  - setId
```
public void setId(long id)
```
    Set this item's id number.
    
    Parameters:
    
    id - id number.

Class RecordRingItem

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RecordRingItem

RecordRingItem

Method Detail

reset

getRecord

getOrder

getSequence

getSequenceObj

fromProducer

fromConsumer

splitFileAfterWrite

splitFileAfterWrite

forceToDisk

forceToDisk

isCheckDisk

setCheckDisk

isLastItem

setLastItem

isAlreadyReleased

setAlreadyReleased

getId

setId