Top Description Fields Methods
org.apache.derby.iapi.store.raw

public Interface StreamContainerHandle

Known Direct Implementers
org.apache.derby.impl.store.raw.data.StreamFileContainerHandle
Imports
org.apache.derby.shared.common.error.StandardException, org.apache.derby.iapi.types.DataValueDescriptor, java.util.Properties

A Stream Container handle

Field Summary

Modifier and TypeField and Description
public static final int

Method Summary

Modifier and TypeMethod and Description
public void
close()

Close me.

public boolean
fetchNext(DataValueDescriptor[]
Row to be filled in with information from the record.
row
)

Fetch the next record.

public void
getContainerProperties(Properties
Property list to fill in.
prop
)

Request the system properties associated with a container.

public ContainerKey
getId()

Return my identifier.

public void
removeContainer()

remove the stream container

Field Detail

TEMPORARY_SEGMENTback to summary
public static final int TEMPORARY_SEGMENT

Method Detail

closeback to summary
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.
fetchNextback to summary
public boolean fetchNext(DataValueDescriptor[] row) throws 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.

Parameters
row:DataValueDescriptor[]

Row to be filled in with information from the record.

Exceptions
StandardException:
Standard Derby error policy
getContainerPropertiesback to summary
public void getContainerProperties(Properties prop) throws 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"); }

Parameters
prop:Properties

Property list to fill in.

Exceptions
StandardException:
Standard exception policy.
getIdback to summary
public ContainerKey getId()

Return my identifier.

removeContainerback to summary
public void removeContainer() throws StandardException

remove the stream container

Exceptions
StandardException:
Standard Derby error policy