| Package | Description |
|---|---|
| org.mmbase.core | |
| org.mmbase.core.util | |
| org.mmbase.module.core |
The core classes for MMBase.
|
| org.mmbase.storage |
The interfaces that define the classes for persistent storage of objects.
|
| org.mmbase.storage.implementation.database | |
| org.mmbase.storage.search |
Provides interfaces for retrieval of data from
SearchQuery objects. |
| org.mmbase.storage.util |
| Modifier and Type | Method and Description |
|---|---|
Object |
CoreField.getStorageIdentifier()
Returns a storage identifier for this object.
|
| Modifier and Type | Method and Description |
|---|---|
MMObjectNode |
StorageConnector.getNode(int number,
boolean useCache)
Retrieves a node based on it's number (a unique key).
|
int |
StorageConnector.getNodeType(int number)
Retrieves an object's type.
|
| Modifier and Type | Method and Description |
|---|---|
SearchQueryHandler |
MMBase.getSearchQueryHandler()
Returns a SearchQueryHandler to access the storage..
|
StorageManager<?> |
MMBase.getStorageManager()
Returns a StorageManager to access the storage..
|
| Modifier and Type | Class and Description |
|---|---|
class |
StorageConfigurationException
This exception gets thrown when an error occurred in the configuration of a StorageFactory or a
storage manager.
|
class |
StorageFactoryException
This exception gets thrown when an error occurred during instantiation of the StorageFactory.
|
class |
StorageInaccessibleException
This exception gets thrown when the storage is inaccessible, such as when files were moved, a database goes offline,
or user rights on the storage were insufficient to allow access.
|
class |
StorageNotFoundException
This exception gets thrown if a query resulted nothing, in contrary to the expectation (for example in 'getNode').
|
| Modifier and Type | Method and Description |
|---|---|
void |
StorageManagerFactory.beginTransaction()
Puts the current thread in a database transaction
|
void |
StorageManager.beginTransaction()
Starts a transaction on this StorageManager instance.
|
void |
StorageManager.change(CoreField field)
Changes a field to the storage of this builder.
|
void |
StorageManager.change(MMObjectBuilder builder)
Changes the storage of a builder to match its new configuration.
|
void |
StorageManager.change(MMObjectNode node)
Commit this node to the specified builder.
|
void |
StorageManagerFactory.commit()
Commits the current thread's database transaction
|
void |
StorageManager.commit()
Closes any transaction that was started and commits all changes.
|
void |
StorageManager.create()
Create the basic elements for this storage
|
void |
StorageManager.create(CoreField field)
Creates a field and adds it to the storage of this builder.
|
void |
StorageManager.create(MMObjectBuilder builder)
Create a storage element to store the specified builder's objects.
|
int |
StorageManager.create(MMObjectNode node)
This method creates a new object in the storage, and registers the change.
|
int |
StorageManager.createKey()
Gives an unique number for a new node, to be inserted in the storage.
|
protected SM |
StorageManagerFactory.createStorageManager() |
void |
StorageManager.delete(CoreField field)
Deletes a field from the storage of this builder.
|
void |
StorageManager.delete(MMObjectBuilder builder)
Drops the storage of this builder.
|
void |
StorageManager.delete(MMObjectNode node)
Delete a node
|
boolean |
StorageManager.exists()
Determine if the basic storage elements exist
Basic storage elements include the 'object' storage (where all objects and their types are registered).
|
boolean |
StorageManager.exists(MMObjectBuilder builder)
Determine if a storage element exists for storing the given builder's objects
|
byte[] |
StorageManager.getBinaryValue(MMObjectNode node,
CoreField field)
Retrieve a large binary object (byte array) for a specified object field.
|
StorageReader<SM> |
StorageManagerFactory.getDocumentReader()
Locates and opens the storage configuration document, if available.
|
InputStream |
StorageManager.getInputStreamValue(MMObjectNode node,
CoreField field) |
MMObjectNode |
StorageManager.getNode(MMObjectBuilder builder,
int number)
Select a node from a specified builder
|
int |
StorageManager.getNodeType(int number)
Returns the nodetype for a specified nodereference
|
SearchQueryHandler |
StorageManagerFactory.getSearchQueryHandler()
Obtains a SearchQueryHandler from the factory.
|
Object |
StorageManagerFactory.getStorageIdentifier()
Obtains the identifier for the basic storage element.
|
Object |
Storable.getStorageIdentifier()
Returns a storage identifier for this object.
|
Object |
StorageManagerFactory.getStorageIdentifier(Object mmobject)
Obtains a identifier for an MMBase object.
|
SM |
StorageManagerFactory.getStorageManager()
Obtains a StorageManager from the factory.
|
String |
StorageManager.getStringValue(MMObjectNode node,
CoreField field)
Retrieve a large text for a specified object field.
|
void |
StorageManager.init(SMF factory)
Initializes the manager.
|
boolean |
StorageManager.isNull(MMObjectNode node,
CoreField field)
Checks for null values for a field from the storage of this builder.
|
protected void |
StorageManagerFactory.load()
Opens and reads the storage configuration document.
|
static StorageManagerFactory |
StorageManagerFactory.newInstance()
Obtain the storage manager factory belonging to the default MMBase module.
|
static StorageManagerFactory |
StorageManagerFactory.newInstance(MMBase mmbase)
Obtain the StorageManagerFactory belonging to the indicated MMBase module.
|
boolean |
StorageManagerFactory.rollback()
Rolls back the current thread's database transaction
|
boolean |
StorageManager.rollback()
Cancels any transaction that was started and rollback changes if possible.
|
int |
StorageManager.setNodeType(MMObjectNode node,
MMObjectBuilder builder) |
int |
StorageManager.size()
Return the total number of objects in the storage
|
int |
StorageManager.size(MMObjectBuilder builder)
Return the number of objects of a builder in the storage
|
| Modifier and Type | Method and Description |
|---|---|
void |
DatabaseStorageManager.beginTransaction() |
void |
DatabaseStorageManager.change(CoreField field) |
void |
DatabaseStorageManager.change(MMObjectBuilder builder) |
void |
DatabaseStorageManager.change(MMObjectNode node) |
protected void |
DatabaseStorageManager.change(MMObjectNode node,
MMObjectBuilder builder)
Change this node in the specified builder.
|
void |
ViewDatabaseStorageManager.change(MMObjectNode node,
MMObjectBuilder builder)
Changes a node in the passed builder and all its parent builders
|
void |
RelationalDatabaseStorageManager.change(MMObjectNode node,
MMObjectBuilder builder)
Changes a node in the passed builder and all its parent builders
|
void |
DatabaseStorageManager.commit() |
void |
DatabaseStorageManager.create() |
void |
ViewDatabaseStorageManager.create()
Create the basic elements for this storage
|
void |
DatabaseStorageManager.create(CoreField field) |
protected void |
DatabaseStorageManager.create(Index index)
Create an index or a unique constraint.
|
protected void |
ViewDatabaseStorageManager.create(Index index)
Override the default version.
|
void |
DatabaseStorageManager.create(MMObjectBuilder builder) |
void |
ViewDatabaseStorageManager.create(MMObjectBuilder builder)
Create a storage element to store the specified builder's objects.
|
int |
DatabaseStorageManager.create(MMObjectNode node) |
protected void |
DatabaseStorageManager.create(MMObjectNode node,
MMObjectBuilder builder)
This method inserts a new object in a specific builder, and registers the change.
|
void |
ViewDatabaseStorageManager.create(MMObjectNode node,
MMObjectBuilder builder) |
void |
RelationalDatabaseStorageManager.create(MMObjectNode node,
MMObjectBuilder builder)
Adds a node to the passed builder and all its parent builders.
|
protected void |
DatabaseStorageManager.createIndices(CoreField field)
(Re)create all constraints and indices that contain a specific field.
|
int |
DatabaseStorageManager.createKey() |
protected void |
ViewDatabaseStorageManager.createObject(MMObjectNode node,
MMObjectBuilder builder)
This method inserts a new object in a specific builder, and registers the change.
|
protected void |
DatabaseStorageManager.createSequence()
Creates a means for the database to pre-create keys with increasing numbers.
|
void |
DatabaseStorageManager.delete(CoreField field) |
protected void |
DatabaseStorageManager.delete(Index index)
Drop a constraint or index.
|
void |
DatabaseStorageManager.delete(MMObjectBuilder builder) |
void |
DatabaseStorageManager.delete(MMObjectNode node) |
protected void |
DatabaseStorageManager.delete(MMObjectNode node,
MMObjectBuilder builder)
Delete a node from a specific builder
This method makes it easier to implement relational databases, where you may need to remove the node
in more than one builder.
|
void |
ViewDatabaseStorageManager.delete(MMObjectNode node,
MMObjectBuilder builder)
Deletes a node in the passed builder and all its parent builders.
|
void |
RelationalDatabaseStorageManager.delete(MMObjectNode node,
MMObjectBuilder builder)
Deletes a node in the passed builder and all its parent builders.
|
protected void |
DatabaseStorageManager.deleteIndices(CoreField field)
Drop all constraints and indices that contain a specific field.
|
boolean |
DatabaseStorageManager.exists() |
boolean |
ViewDatabaseStorageManager.exists()
Determine if the basic storage elements exist
Basic storage elements include the 'object' storage (where all objects and their types are registered).
|
protected boolean |
DatabaseStorageManager.exists(Index index)
Determines if an index exists.
|
protected boolean |
ViewDatabaseStorageManager.exists(Index index) |
boolean |
DatabaseStorageManager.exists(MMObjectBuilder builder) |
boolean |
ViewDatabaseStorageManager.exists(MMObjectBuilder builder)
Determine if a storage element exists for storing the given builder's objects
|
protected boolean |
DatabaseStorageManager.exists(String tableName)
Queries the database metadata to test whether a given table exists.
|
protected void |
DatabaseStorageManager.fillNode(MMObjectNode node,
ResultSet result,
MMObjectBuilder builder)
Fills a single Node from the resultset of a query.
|
byte[] |
DatabaseStorageManager.getBinaryValue(MMObjectNode node,
CoreField field) |
Blob |
DatabaseStorageManager.getBlobValue(MMObjectNode node,
CoreField field) |
Blob |
DatabaseStorageManager.getBlobValue(MMObjectNode node,
CoreField field,
boolean mayShorten) |
protected Blob |
PostgresqlLargeObjectStorageManager.getBlobValue(ResultSet result,
int index,
CoreField field,
boolean mayShorten)
Replaces it super class method and calls
PostgresqlLargeObjectStorageManager.getBlobValueFromLargeObject(ResultSet, int, CoreField, boolean)
instead. |
protected Blob |
DatabaseStorageManager.getBlobValue(ResultSet result,
int index,
CoreField field,
boolean mayShorten)
Retrieve a large binary object (byte array) for a specified object field.
|
protected Blob |
PostgresqlLargeObjectStorageManager.getBlobValueFromLargeObject(ResultSet result,
int index,
CoreField field,
boolean mayShorten)
Retrieves a Blob from the database using the PostgreSQL LargeObject API.
|
protected Boolean |
DatabaseStorageManager.getBooleanValue(ResultSet result,
int index,
CoreField field)
Retrieve a boolean value for a specified object field.
|
protected String |
DatabaseStorageManager.getConstraintDefinition(CoreField field)
Creates an index definition string for a field to be passed when creating a table.
|
protected Date |
DatabaseStorageManager.getDateTimeValue(ResultSet result,
int index,
CoreField field)
Retrieve a date for a specified object field.
|
StorageReader |
DatabaseStorageManagerFactory.getDocumentReader()
Locates and opens the storage configuration document, if available.
|
protected String |
DatabaseStorageManager.getFieldDefinition(CoreField field)
Creates a fielddefinition, of the format '[fieldname] [fieldtype] NULL' or
'[fieldname] [fieldtype] NOT NULL' (depending on whether the field is nullable).
|
String |
DatabaseStorageManager.getFieldTypeDefinition(CoreField field)
Creates a field type definition, of the format '[fieldtype] NULL' or
'[fieldtype] NOT NULL' (depending on whether the field is nullable).
|
InputStream |
DatabaseStorageManager.getInputStreamValue(MMObjectNode node,
CoreField field) |
MMObjectNode |
DatabaseStorageManager.getNode(MMObjectBuilder builder,
int number) |
int |
DatabaseStorageManager.getNodeType(int number) |
String |
DatabaseStorageManager.getStringValue(MMObjectNode node,
CoreField field) |
protected Object |
DatabaseStorageManager.getStringValue(ResultSet result,
int index,
CoreField field,
boolean mayShorten)
Retrieve a text for a specified object field.
|
Object |
DatabaseStorageManager.getValue(ResultSet result,
int index,
CoreField field,
boolean mayShorten)
Attempts to return a single field value from the resultset of a query.
|
protected Document |
DatabaseStorageManager.getXMLValue(ResultSet result,
int index,
CoreField field,
boolean mayShorten)
Retrieve the XML (as a string) for a specified object field.
|
void |
DatabaseStorageManager.init(DatabaseStorageManagerFactory factory) |
boolean |
DatabaseStorageManager.isNull(MMObjectNode node,
CoreField field) |
protected void |
DatabaseStorageManagerFactory.load()
Opens and reads the storage configuration document.
|
protected void |
DatabaseStorageManager.refresh(MMObjectNode node)
Reloads the data from a node from the database.
|
boolean |
DatabaseStorageManager.rollback() |
protected void |
PostgresqlLargeObjectStorageManager.setBinaryValue(PreparedStatement statement,
int index,
Object objectValue,
CoreField field,
MMObjectNode node)
Writes the binary objectValue to to a LargeObject and stores the
resulting oid as long in the statement.
|
protected void |
DatabaseStorageManager.setBinaryValue(PreparedStatement statement,
int index,
Object objectValue,
CoreField field,
MMObjectNode node)
Store binary data of a field in a prepared statement.
|
protected void |
DatabaseStorageManager.setBooleanValue(PreparedStatement statement,
int index,
Object value,
CoreField field,
MMObjectNode node)
Store a boolean value of a field in a prepared statement.
|
protected void |
DatabaseStorageManager.setDateTimeValue(PreparedStatement statement,
int index,
Object value,
CoreField field,
MMObjectNode node)
Store a Date value of a field in a prepared statement.
|
protected void |
DatabaseStorageManager.setDecimalValue(PreparedStatement statement,
int index,
Object value,
CoreField field,
MMObjectNode node) |
protected void |
DatabaseStorageManager.setListValue(PreparedStatement statement,
int index,
Object value,
CoreField field,
MMObjectNode node)
Store a List value of a field in a prepared statement.
|
int |
DatabaseStorageManager.setNodeType(MMObjectNode node,
MMObjectBuilder bul) |
protected void |
DatabaseStorageManager.setNodeTypeLeaveRelations(MMObjectNode node,
MMObjectBuilder buil)
Deletes the node, and recreates it in a different table.
|
protected void |
DatabaseStorageManager.setNodeTypeRememberRelations(MMObjectNode node,
MMObjectBuilder buil)
Deletes the node, and recreates it in a different table.
|
protected void |
DatabaseStorageManager.setNodeValue(PreparedStatement statement,
int index,
Object nodeValue,
CoreField field,
MMObjectNode node)
Store a node value of a field in a prepared statement
Nodes are stored in the database as numeric values.
|
protected boolean |
DatabaseStorageManager.setNullValue(PreparedStatement statement,
int index,
Object value,
CoreField field,
int type)
Stores the 'null' value in the statement if appopriate (the value is null or unset, and the
value may indeed be NULL, according to the configuration).
|
protected void |
DatabaseStorageManager.setNumericValue(PreparedStatement statement,
int index,
Object value,
CoreField field,
MMObjectNode node)
Store a numeric value of a field in a prepared statement
The method uses the Casting class to convert to the appropriate value.
|
protected Object |
DatabaseStorageManager.setStringValue(PreparedStatement statement,
int index,
Object objectValue,
CoreField field,
MMObjectNode node)
Store the text value of a field in a prepared statement.
|
protected void |
DatabaseStorageManager.setValue(PreparedStatement statement,
int index,
MMObjectNode node,
CoreField field)
Store the value of a field in a prepared statement
|
protected void |
DatabaseStorageManager.setXMLValue(PreparedStatement statement,
int index,
Object objectValue,
CoreField field,
MMObjectNode node)
|
protected void |
RelationalDatabaseStorageManager.simpleCreate(MMObjectNode node,
MMObjectBuilder builder)
Actual implementation of
RelationalDatabaseStorageManager.create(MMObjectNode, MMObjectBuilder) which wraps this in a
transction only, now. |
int |
DatabaseStorageManager.size() |
int |
DatabaseStorageManager.size(MMObjectBuilder builder) |
protected void |
DatabaseStorageManager.storeBinaryAsFile(MMObjectNode node,
CoreField field)
Store a binary (blob) data file
|
void |
DatabaseStorageManager.verify(MMObjectBuilder builder)
Tests whether a builder and the table present in the database match.
|
void |
ViewDatabaseStorageManager.verify(MMObjectBuilder builder) |
| Modifier and Type | Method and Description |
|---|---|
List<MMObjectNode> |
ResultBuilder.getResult() |
| Modifier and Type | Method and Description |
|---|---|
String |
Scheme.format(Object... params)
Applies the parameters to the scheme's pattern.
|
protected Object |
Scheme.resolveParameter(Object param)
Resolves an object (passed as a parameter) to a value that can be applied in a pattern.
|
MMBase 1.9-SNAPSHOT - ${javadoctimestamp}