|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface TSchemaDefinition3Accessor
TSchemaDefinition3Accessor is the interface for the access of TSD3 schema information. The basic operations are define and undefine. Each of these operations returns a TResponse instance containing the information as returned by Tamino in its response document. TSD2 schema information can not be accessed by this type of accessor.
Method Summary | |
---|---|
TResponse |
define(TXMLObject schemaObject)
Defines a schema represented by the schemaObject input parameter in the Tamino database. |
TResponse |
define(TXMLObject[] schemaObjects)
Defines multiple schemas stored in an array of dataObjects. |
TResponse |
define(TXMLObject[] schemaObjects,
TDefineMode defineMode)
Defines multiple schemas stored in an array of dataObjects. |
TResponse |
define(TXMLObject schemaObject,
boolean asTest)
Deprecated. Please use the method define( TXMLObject schemaObject, TDefineMode defineMode ) instead. |
TResponse |
define(TXMLObject schemaObject,
TDefineMode defineMode)
Defines a Tamino schema depending on the defineMode indicator into the current database. |
java.util.Iterator<java.lang.String> |
getCollectionNames()
Gets an iterator for the list of all collection names referenced by TSD3 schemas. |
java.util.Iterator<java.lang.String> |
getDoctypeNames(java.lang.String collection,
java.lang.String schema)
Gets an iterator for the list of all TSD3 doctype names in the specified collection and schema. |
java.util.Iterator<java.lang.String> |
getRootElementNames(java.lang.String collection)
Gets the root element names within the specified collection. |
TResponse |
getSchema(java.lang.String collection,
java.lang.String schema)
Gets the schema or set of schemas for the given collection and schema name. |
java.util.Iterator<java.lang.String> |
getSchemaNames(java.lang.String collection)
Gets an iterator for the list of all TSD3 schema names in the specified collection. |
java.util.Iterator<java.lang.String> |
getUndefinedRootElementNames(java.lang.String collection)
Gets the root element names within the specified collection wich do not belong to any defined schema. |
TResponse |
undefine(java.lang.String collection,
java.lang.String schema)
Undefines a schema specified by its name from the specified collection. |
TResponse |
undefine(TUndefineItem[] undefineItems)
In order to undefine a schema cluster, it is possible to specify a list of objects in an _UNDEFINE command: _UNDEFINE=undefineList where- undefineList -> undefineItem[, undefineItem]* undefineItem -> collection[/schema[/doctype]] |
Methods inherited from interface com.softwareag.tamino.db.api.accessor.TAccessor |
---|
cancelRequests, getAccessLocation, getApplicationName, getCanBeCancelled, getLockMode, getLockwaitMode, getMaximumRequestDuration, setAccessLocation, setApplicationName, setCanBeCancelled, setLockMode, setLockwaitMode, setMaximumRequestDuration |
Methods inherited from interface com.softwareag.tamino.db.api.accessor.TInvalidatableAccessor |
---|
invalidate |
Method Detail |
---|
java.util.Iterator<java.lang.String> getCollectionNames() throws TQueryException
TQueryException
- signals an error while attempting to query for the collection names.java.util.Iterator<java.lang.String> getSchemaNames(java.lang.String collection) throws TQueryException
collection
- the collection for which all TSD3 schema names are to be returned; null or an
empty string indicates no collection is specified.
TQueryException
- signals an error while attempting to query for the schema names.java.util.Iterator<java.lang.String> getDoctypeNames(java.lang.String collection, java.lang.String schema) throws TQueryException
collection
- the collection for which all TSD3 doctype names are to be returned; null or an
empty string indicates no collection is specified.schema
- the schema for which all TSD3 doctype names are to be returned; null or an
empty string indicates no schema is specified.
TQueryException
- signals an error while attempting to query for the doctype names.TResponse getSchema(java.lang.String collection, java.lang.String schema) throws TQueryException
collection
- the collection for which all TSD3 schemas are to be returned; null or an
empty string indicates no collection is specified.schema
- the schema which is to be returned; null or an empty string indicates no
schema is specified.
TQueryException
- signals an error while attempting to query for the schemas.java.util.Iterator<java.lang.String> getRootElementNames(java.lang.String collection) throws TQueryException
collection
- the collection for which all root element names will be retrieved.
TQueryException
- signals an error while attempting to query for the schemas.java.util.Iterator<java.lang.String> getUndefinedRootElementNames(java.lang.String collection) throws TQueryException
collection
- the collection for which all undefined root element names will be retrieved.
TQueryException
- signals an error while attempting to query for the schemas.TResponse define(TXMLObject schemaObject) throws TDefineException
schemaObject
- containing the TSD3 schema to be defined in Tamino.
TDefineException
- signals an error while attempting the define operation.TResponse define(TXMLObject schemaObject, boolean asTest) throws TDefineException
dataObject
- containing the TSD3 schema to be defined in Tamino.asTest
- indicates if the input schema should only be tested. If true the schema is tested otherwise
the schema is physically defined.
TDefineException
- signals an error while attempting the define operation.TResponse define(TXMLObject schemaObject, TDefineMode defineMode) throws TDefineException
schemaObject
- denotes the schema instance which should be defined on Tamino.defineMode
- indicates if the input schema should only be tested and if it should be validated.
TDefineException
- if the define for the given schema instance fails. This is the case regardless
of the value for the asTest parameter.TResponse define(TXMLObject[] schemaObjects) throws TDefineException
array
- of dataObjects containing the schemas to be defined in Tamino.
TDefineException
- signals an error while attempting the define operation.TResponse define(TXMLObject[] schemaObjects, TDefineMode defineMode) throws TDefineException
array
- of dataObjects containing the schemas to be defined in Tamino.defineMode
- indicates if the input schema should only be tested and if it should be validated.
TDefineException
- signals an error while attempting the define operation.TResponse undefine(java.lang.String collection, java.lang.String schema) throws TUndefineException
collection
- name of the Tamino collection.schema
- name of a Tamino schema, if null or an empty string the collection is undefined.
TUndefineException
- signals an error while attempting the undefine operation.TResponse undefine(TUndefineItem[] undefineItems) throws TUndefineException
undefineItems
- Array of undefineItems.
TUndefineException
- signals an error while attempting the undefine operation.TUndefineItem
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |