StreamContainerHandle

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> apache >> derby >> iapi >> store >> [ raw overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.apache.derby.iapi.store.raw.StreamContainerHandle

SOURCE |

Download org.apache.derby.iapi.store.raw.StreamContainerHandle

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.derby.iapi.store.raw
Interface StreamContainerHandle

public interface StreamContainerHandle

A Stream Container handle

Field Summary

static int TEMPORARY_SEGMENT


Method Summary

void close()
          Close me.

boolean fetchNext(org.apache.derby.iapi.types.DataValueDescriptor[] row)
          Fetch the next record.

void getContainerProperties(java.util.Properties prop)
          Request the system properties associated with a container.

ContainerKey getId()
          Return my identifier.

void removeContainer()
          remove the stream container

Field Detail

TEMPORARY_SEGMENT

public static final int TEMPORARY_SEGMENT

See Also:: Constant Field Values

Method Detail

getId

public ContainerKey getId()

Return my identifier.

getContainerProperties

public void getContainerProperties(java.util.Properties prop)
                            throws org.apache.derby.iapi.error.StandardException

Request the system properties associated with a container.

Request the value of properties that are associated with a stream table. The following properties can be requested: derby.storage.streamFileBufferSize

To get the value of a particular property add it to the property list, and on return the value of the property will be set to it's current value. For example: get_prop(ConglomerateController cc) { Properties prop = new Properties(); prop.put("derby.storage.streamFileBufferSize", ""); cc.getTableProperties(prop); System.out.println( "table's buffer size = " + prop.getProperty("derby.storage.streamFileBufferSize"); }

fetchNext

public boolean fetchNext(org.apache.derby.iapi.types.DataValueDescriptor[] row)
                  throws org.apache.derby.iapi.error.StandardException

Fetch the next record. Fills in the Storable columns within the passed in row if row is not null, otherwise the record is not fetched. If the row.length is less than the number of fields in the row, then, will fill the row, and ignore the rest of the row.
When no more row is found, then false is returned.

Locking Policy
No locks.

close

public void close()

Close me. After using this method the caller must throw away the reference to the Container object, e.g.

                        ref.close();
                        ref = null;

The container will be closed automatically at the commit or abort of the transaction if this method is not called explictly.

removeContainer

public void removeContainer()
                     throws org.apache.derby.iapi.error.StandardException

remove the stream container