| Home >> All >> org >> apache >> derby >> iapi |
Package Samples:
• org.apache.derby.iapi.db
• org.apache.derby.iapi.error
• org.apache.derby.iapi.jdbc
• org.apache.derby.iapi.reference
• org.apache.derby.iapi.services.cache
• org.apache.derby.iapi.services.classfile
• org.apache.derby.iapi.services.compiler
• org.apache.derby.iapi.services.context
• org.apache.derby.iapi.services.crypto
• org.apache.derby.iapi.services.daemon
• org.apache.derby.iapi.services.diag
• org.apache.derby.iapi.services.i18n
• org.apache.derby.iapi.services.info
• org.apache.derby.iapi.services.io
• org.apache.derby.iapi.services.loader
• org.apache.derby.iapi.services.locks
• org.apache.derby.iapi.services.monitor
• org.apache.derby.iapi.services.property
• org.apache.derby.iapi.services.sanity
• org.apache.derby.iapi.services.stream
Classes:
• ResourceAdapter: The resource adapter is the clearing house for managing connections, transactions, and XAResources in a JDBC based resource manager living in the distributed transaction processing environment. There is one instance of ResourceAdapter per Resource Manager (database). The ResourceAdapter is responsible for keeping track of all run time global transactions and their state. The resource adapter only knows of run time global transactions, i.e., it does not know of in-doubt global transactions re-created by recovery. The following is an overall design of the JTA implementation in cloudscape, most of ...
• DependencyManager: Dependency Manager Interface The dependency manager tracks needs that dependents have of providers. This is a general purpose interface interface which is associated with a DataDictinary object; infact the dependencymanager is really the datadictionary keeping track of dependcies between objects that it handles (descriptors) as well as prepared statements. The primary example of this is a prepared statement's needs of schema objects such as tables. Dependencies are used so that we can determine when we need to recompile a statement; compiled statements depend on schema objects like tables and constraints, ...
• Monitor: Services A service is a collection of modules that combine to provide the full functionality defined by the service. A service is defined by three pieces of information: A fully qualified java class name that identifies the functionality or API that the service must provide. Typically this class represents a java interface. This class name is termed the factory interface . The identifier of the service. Services are identified by a String, this may be hard-coded, come from a UUID or any other source. An optional java.util.Properties set. The running functionality of the service is provided by a ...
• LogicalUndo: A Logical undo is an undo operation that operates on a different page from the page that has the original change. The reason one would need logical undo is when an uncommitted row move from one page to another in a nested internal transaction which is committed. For example, an uncommitted insert on a btree may be moved by a later split operation to another page, the split operation will have committed. If the insert needs to be rolled back, it can only be found at the new page where the split puts it and not at the original page where it is inserted. The logging and recovery system does not know ...
• ContainerHandle: A Container contains a contigious address space of pages, the pages start at page number Container.FIRST_PAGE_NUMBER and are numbered sequentially. The page size is set at addContainer() time. RESOLVE: this style of coding is not currently enforced If the caller calls getPage (or one of its variants) more than once on the same page, the caller must call unlatch a corresponding number of times in order to ensure that the page is latched. For example: Container c; Page p1 = c.getPage(Container.FIRST_PAGE_NUMBER); Page p2 = c.getPage(Container.FIRST_PAGE_NUMBER); p1.unlatch(); -- Page is still latched. ...
• SQLState: List of error message identifiers. This is the set of message identifiers. The message identifier also encodes the SQLState as the first five characters. StandardExceptions must be created using the static StandardException.newException() method calls, passing in a field from this class. The five character SQL State is obtained from a StandardException using the zero-argument StandardException.getSQLState() method. The message identifier (ie. the value that matches a field in this class) is obtained using the zero-argument StandardException.getMessageId() method. Thus if checking for a specific ...
• ProductVersionHolder: Class to hold a cloudscape Product version. This class includes the following product version features. Save the product version information this holds as a String. We call the string a 'product version string'. Construct a ProductVersionHolder from a valid 'product version string'. Determine if two product versions are feature compatible. This means products of these versions may interoperate with ***NO*** compatibility problems. Determine if two product versions are the same. This is a stronger test than the test for feature compatibility. Cloudscape 5.1 and older versions used the majorVersion, ...
• TableDescriptor: This class represents a table descriptor. The external interface to this class is: external interface public String getSchemaName(); public String getQualifiedName(); public int getTableType(); public long getHeapConglomerateId() throws StandardException; public int getNumberOfColumns(); public FormatableBitSet getReferencedColumnMap(); public void setReferencedColumnMap(FormatableBitSet referencedColumnMap); public int getMaxColumnID() throws StandardException; public void setUUID(UUID uuid); public char getLockGranularity(); public void setTableName(String newTableName); public void setLockGranularity(char ...
• JavaFactory: JavaFactory provides generators for Java constructs. Once Java constructs have been connected into a complete class definition, the class can be generated from them. The generated class is created as a byte-code array that can then be loaded by a class loader or, in our case, the class utilities wrapper around our special class loader. Each method shows the equivalent Java in the line starting "Java:" in the header comment. Items in the java code that begin with # refer to parameters used in constructing the object. So, for example, newReturnStatement takes a parameter named value; its Java code ...
• Lockable: Any object that needs to be locked must implement Lockable. This allows a generic lock manager that can have locking policies defined on a per-object basis. A request to lock the object takes a qualifier, this qualifier may be used the object to implement a complex locking policy, e.g. traditional database shared, update and exclusive locks. The lock manager uses this ordered protocol to determine if a lock request on a Lockable L with qualifier Q1 in compatiblity space CS1 can be granted: If no locks are held on L in any compatability space then the request is granted. If L.requestCompatible(Q1) ...
• Page: A Page contains an ordered set of records which are the stored form of rows. A record is a stream of bytes created from a row array. The record contains one or more fields, fields have a one to one correlation with the DataValueDescriptor's contained within a row array. A Page represents exclusive access to a data page within a container. Exclusive access is released by calling the unlatch() method, once that occurs the caller must no longer use the Page reference. Several of the methods in Page take a RecordHandle as an argument. RecordHandles are obtained from a Page, while holding exclusive ...
• RawStoreFactory: RawStoreFactory implements a single unit of transactional storage. A RawStoreFactory contains Segments and Segments contain Containers. Segments are identified by integer identifiers that are unique within a RawStoreFactory. Containers are also identified by unique integer identifiers within a RawStoreFactory, but will overlap with segment identifiers. LIMITS This is a list of (hopefully) all limits within the raw store. Where a size has more than one limit all are documented (rather than just the most restrictive) so that the correct limit can be found if the most restictive is every removed. ...
• RowUtil: A set of static utility methods to work with rows. A row or partial row is described by two or three parameters. DataValueDescriptor[] row - an array of objects, one per column. FormatableBitSet validColumns - an indication of which objects in row map to which columns These objects can describe a complete row or a partial row. A partial row is one where a sub-set (e.g. columns 0, 4 and 7) of the columns are supplied for update, or requested to be fetched on a read. Here's an example of code to set up a partial column list to fetch the 0th (type FOO), 4th (type BAR), and 7th (type MMM) columns from ...
• StoredFormatIds: A format id identifies a stored form of an object for the purposes of locating a class which can read the stored form and reconstruct the object using the java.io.Externalizable interface. An important aspect of the format id concept is that it does not impose an implementation on the stored object. Rather, multiple implementations of an object (or interface) may share a format id. One implementation may store (write) an object and another may restore (read) the object. The implication of this is that a format id specifies the following properties of a stored object. The interface(s) the stored ...
• OnlineCompress: Implementation of SYSCS_UTIL.SYSCS_INPLACE_COMPRESS_TABLE(). Code which implements the following system procedure: void SYSCS_UTIL.SYSCS_INPLACE_COMPRESS_TABLE( IN SCHEMANAME VARCHAR(128), IN TABLENAME VARCHAR(128), IN PURGE_ROWS SMALLINT, IN DEFRAGMENT_ROWS SMALLINT, IN TRUNCATE_END SMALLINT) This system procedure can be used to force 3 levels of in place compression of a SQL table. The table is specified using the SCHEMANAME and TABLENAME arguments. If PURGE_ROWS is set to non-zero then a single pass is made through the table which will purge committed deleted rows from the table. This space ...
• FormatIdOutputStream: A stream for serializing objects with format id tags. An ObjectOutput (henceforth 'out') preceeds objects it writes with a format id. The companion FormatIdInputStream (henceforth 'in') uses these format ids in parsing the stored data. The stream can be thought of as containing a sequence of (formatId,object) pairs interspersed with other data. The assumption is that out.writeObject() produces these pairs and in.readObject() uses the format ids to construct objects from the pairs that out.writeObject produced. The description below describes each supported pair and how in.readObject() processes ...
• BackingStoreHashtable: A BackingStoreHashtable is a utility class which will store a set of rows into an in memory hash table, or overflow the hash table to a tempory on disk structure. All rows must contain the same number of columns, and the column at position N of all the rows must have the same format id. If the BackingStoreHashtable needs to be overflowed to disk, then an arbitrary row will be chosen and used as a template for creating the underlying overflow container. The hash table will be built logically as follows (actual implementation may differ). The important points are that the hash value is the standard ...
• DataValueDescriptor: The DataValueDescriptor interface provides methods to get the data from a column returned by a statement. This interface has the same methods as NoCastDataValueDescriptor - the only reason it exists is for purposes of internal documentation, to make it clear when the different getXXX methods throw exceptions for illegal conversions. This interface matches the getXXX methods on java.sql.ResultSet. This means everyone satisfies getString and getObject; all of the numeric types, within the limits of representation, satisfy all of the numeric getXXX methods; all of the character types satisfy all of ...
• SQLBinary: SQLBinary satisfies the DataValueDescriptor interfaces (i.e., DataType). It implements a String holder, e.g. for storing a column value; it can be specified when constructed to not allow nulls. Nullability cannot be changed after construction. Because DataType is a subclass of DataType, SQLBit can play a role in either a DataType/Value or a DataType/KeyRow, interchangeably. Format : Length is encoded to support 5.x databases where the length was stored as the number of bits. The first bit of the first byte indicates if the format is an old (5.x) style or a new 8.1 style. 8.1 then uses the next ...
• SQLBit: SQLBit satisfies the DataValueDescriptor interfaces (i.e., DataType). It implements a String holder, e.g. for storing a column value; it can be specified when constructed to not allow nulls. Nullability cannot be changed after construction. Because DataType is a subclass of DataType, SQLBit can play a role in either a DataType/Value or a DataType/KeyRow, interchangeably. Format : Length is encoded to support 5.x databases where the length was stored as the number of bits. The first bit of the first byte indicates if the format is an old (5.x) style or a new 8.1 style. 8.1 then uses the next two ...
• Cacheable: Any object that implements this interface can be cached using the services of the CacheManager/CacheFactory. In addition to implementing this interface the class must be public and it must have a public no-arg constructor. This is because the cache manager will construct objects itself and then set their identity by calling the setIdentity method. A Cacheable object has five states: No identity - The object is only accessable by the cache manager Identity, clean, unkept - The object has an identity, is clean but is only accessable by the cache manager Identity, clean, kept - The object has an identity, ...
• CacheableFactory: Any object that implements this interface can be cached using the services of the CacheManager/CacheFactory. In addition to implementing this interface the class must be public and it must have a public no-arg constructor. This is because the cache manager will construct objects itself and then set their identity by calling the setIdentity method. A Cacheable object has five states: No identity - The object is only accessable by the cache manager Identity, clean, unkept - The object has an identity, is clean but is only accessable by the cache manager Identity, clean, kept - The object has an identity, ...
• ConglomerateController: A conglomerate is an abstract storage structure (they correspond to access methods). The ConglomerateController interface is the interface that access manager clients can use to manipulate the contents of the underlying conglomerate. Each conglomerate holds a set of rows. Each row has a row location. The conglomerate provides methods for: Inserting rows, Fetching, deleting, and replacing entire rows by row location, and fetching and updating individual columns of a row identified by row location. Conglomerates do not provide any mechanism for associative access to rows within the conglomerate; ...
• SortObserver: A SortObserver is an object that is used as a callback by the sorter. It allows the sort client to do whatever they want from the context of a sort. It contains 2 callback methods: insertDuplicateKey() and insertNonDuplicateKey() . On each SortController.insert() , one or the other of these methods will be called, depending on whether the given row has a key that has been seen before or not. Some sample uses include: Sorts from Language : Language typically recycles data type wrappers. So the language layer uses SortObservers to clone rows that are kept by the sorter. Distinct sorts : The sorter ...
• DaemonFactory: Daemon Factory can create new DaemonService, which runs on seperate background threads. One can use these DaemonService to handle background clean up task by implementing Serviceable and subscribing to a DaemonService. A DaemonService is a background worker thread which does asynchronous I/O and general clean up. It should not be used as a general worker thread for parallel execution. A DaemonService can be subscribe to by many Serviceable objects and a daemon will call that object's performWork from time to time. These performWork method should be well behaved - in other words, it should not take ...
| Home | Contact Us | Privacy Policy | Terms of Service |