Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> derby >> impl >> store >> raw >> [ data overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.apache.derby.impl.store.raw.data
Class StreamFileContainerHandle  

java.lang.Object
  org.apache.derby.impl.store.raw.data.StreamFileContainerHandle

All Implemented Interfaces:

java.util.Observer, org.apache.derby.iapi.store.raw.StreamContainerHandle

---

final class StreamFileContainerHandle

extends java.lang.Object

implements org.apache.derby.iapi.store.raw.StreamContainerHandle, java.util.Observer

A handle to an open stream container, implememts StreamContainerHandle.

This class is an Observer to observe RawTransactions
MT - Mutable - Immutable identity - Thread Aware

---

Field Summary
protected  boolean	active           Is this StreamContainerHandle active.
protected  StreamFileContainer	container           The actual container we are accessing.
private  boolean	hold           Whether this container should be held open across commit.
protected  org.apache.derby.iapi.store.raw.ContainerKey	identity           Container identifier MT - Immutable
private  org.apache.derby.catalog.UUID	rawStoreId           Raw Store identifier MT - Immutable
protected  org.apache.derby.iapi.store.raw.xact.RawTransaction	xact           our transaction.

 

Fields inherited from interface org.apache.derby.iapi.store.raw.StreamContainerHandle

TEMPORARY_SEGMENT

 

Constructor Summary

StreamFileContainerHandle(org.apache.derby.catalog.UUID rawStoreId, org.apache.derby.iapi.store.raw.xact.RawTransaction xact, org.apache.derby.iapi.store.raw.ContainerKey identity, boolean hold)

StreamFileContainerHandle(org.apache.derby.catalog.UUID rawStoreId, org.apache.derby.iapi.store.raw.xact.RawTransaction xact, StreamFileContainer container, boolean hold)

 

Method Summary
void	close()           Close me.
boolean	fetchNext(org.apache.derby.iapi.types.DataValueDescriptor[] row)           fetch a row from the container.
void	getContainerProperties(java.util.Properties prop)           Request the system properties associated with a container.
org.apache.derby.iapi.store.raw.ContainerKey	getId()           get the container key for the stream container
org.apache.derby.iapi.store.raw.xact.RawTransaction	getTransaction()           Return the RawTransaction this object was opened in.
void	removeContainer()           remove the stream container
java.lang.String	toString()           Convert this Object to a human-readable String.
void	update(java.util.Observable obj, java.lang.Object arg)           Called when the transaction is about to complete.
boolean	useContainer()           Attach me to a container.

 

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Field Detail

rawStoreId

private final org.apache.derby.catalog.UUID rawStoreId

Raw Store identifier
MT - Immutable

---

identity

protected final org.apache.derby.iapi.store.raw.ContainerKey identity

Container identifier
MT - Immutable

---

active

protected boolean active

Is this StreamContainerHandle active.
MT - Mutable : scoped

---

container

protected StreamFileContainer container

The actual container we are accessing. Only valid when active is true.
MT - Mutable : scoped

---

xact

protected org.apache.derby.iapi.store.raw.xact.RawTransaction xact

our transaction. Only valid when active is true.
MT - Mutable : scoped

---

hold

private boolean hold

Whether this container should be held open across commit. Only valid when active is true.
MT - Mutable : scoped

Constructor Detail

StreamFileContainerHandle

public StreamFileContainerHandle(org.apache.derby.catalog.UUID rawStoreId,
                                 org.apache.derby.iapi.store.raw.xact.RawTransaction xact,
                                 org.apache.derby.iapi.store.raw.ContainerKey identity,
                                 boolean hold)

---

StreamFileContainerHandle

public StreamFileContainerHandle(org.apache.derby.catalog.UUID rawStoreId,
                                 org.apache.derby.iapi.store.raw.xact.RawTransaction xact,
                                 StreamFileContainer container,
                                 boolean hold)

Method Detail

getContainerProperties

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

Request the system properties associated with a container.

Specified by:

getContainerProperties in interface org.apache.derby.iapi.store.raw.StreamContainerHandle

---

fetchNext

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

fetch a row from the container.

Specified by:

fetchNext in interface org.apache.derby.iapi.store.raw.StreamContainerHandle

---

close

public void close()

Description copied from interface: org.apache.derby.iapi.store.raw.StreamContainerHandle

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.

Specified by:

close in interface org.apache.derby.iapi.store.raw.StreamContainerHandle

---

removeContainer

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

remove the stream container

Specified by:

removeContainer in interface org.apache.derby.iapi.store.raw.StreamContainerHandle

---

getId

public org.apache.derby.iapi.store.raw.ContainerKey getId()

get the container key for the stream container

Specified by:

getId in interface org.apache.derby.iapi.store.raw.StreamContainerHandle

---

update

public void update(java.util.Observable obj,
                   java.lang.Object arg)

Called when the transaction is about to complete.

Specified by:

update in interface java.util.Observer

---

useContainer

public boolean useContainer()
                     throws org.apache.derby.iapi.error.StandardException

Attach me to a container. If this method returns false then I cannot be used anymore, and any reference to me must be discarded.

---

getTransaction

public final org.apache.derby.iapi.store.raw.xact.RawTransaction getTransaction()

Return the RawTransaction this object was opened in.

---

toString

public java.lang.String toString()

Description copied from class: java.lang.Object

Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() 55 and such.

It is typical, but not required, to ensure that this method never completes abruptly with a java.lang.RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> derby >> impl >> store >> raw >> [ data overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---