Package com.im.df.api.dml

API Status: 2 - Pretty stable Provides the interfaces that provide data access (create, read, update, delete) for the items in the data model of Discovery Informatics Framework.

See:
Description

Interface Summary

DFEntityDataProvider	Data provider for a single entity.
DFInsertOptions	API Status: not stable.
DFRelationDataProvider	API Status: This interface is not stable.
DFResultSet	This object is used for managing data for a particular DFDataTree.
DFResultSet.VertexState	This object represent state of data of one DFDataTree.Vertex.
DFSchemaDataProvider	The root object for providing data in DIF.
DFTermVisitor	Visitor for DFTerm expressions

Class Summary

DFDeleteDescription
DFEntityDataProviders
DFInsertDescription	This data structure describes a single row to be inserted into the DFInsertDescription.getTargetEntity().
DFOperator	This class represents one operator used by DFTermExpression in DIF API.
DFRowData	Data for a single row in database.
DFScriptXml	Script-specific information that is persisted as XML and stored in DATA column of script DF item.
DFTerm	This object is a superclass of all objects used for definition of expression terms for query execution in DIF.
DFTermExpression	This object represents a complex expression.
DFTermField	This object represents a single existing field in the DFTerm hierarchy; it is a wrapper for such a field and using it, the field can be used in complex DFTerm expressions.
DFTermsFactory	The factory class for creating DFTerms.
DFTermValue	This object represents a constant value in the hierarchical substructure of DFTerms, it's wrapper class around such a constant value.
Operators	The well known built-in operators for DFTermExpression.
Operators.AllDataOperator	Represents all data
Operators.BetweenOperator	A special class for Between operator
Operators.ErrorOperator	A special class for "ERROR" operator.
Operators.IgnoreOperator	A special class for dumb IGNORE operator
Operators.ListOperator	IN LIST and NOT IN LIST operators
Operators.NullOperator	IS NULL/ IS NOT NULL operators
Operators.SimpleFieldValuesOperator	Currently we support only "Field Operator [Value, [Value, ...]]" formats.
Operators.SimpleLogicalOperator	Class for AND/OR operators
Operators.SimpleTextOperator
Operators.StructureOperator	Class for all Structure based operators
TermErrors	Result of the validation: DFTerm.validate(com.im.df.api.ddl.DFDataTree).

Enum Summary

DFDeleteDescription.Type

Exception Summary

DFRelationDataException

Package com.im.df.api.dml Description

API Status: 2 - Pretty stable Provides the interfaces that provide data access (create, read, update, delete) for the items in the data model of Discovery Informatics Framework. This broadly corresponds to the DML aspects of SQL.

Basicaly the stable classes/interfaces of this packages are:

• DFResultSet
• DFSchemaDataProvider
• DFEntityDataProvider

The basic idea of this package is that you use DFSchema getSchemaDataProvider method to obtaining DFSchemaDataProvider instance. There is only one instance of this object per the DFSchema and it provides DFEntityDataProviders - one provider per DFEntity.

If you are doing data changes, you need to lock the DFEntityDataProvider (EDP) using getLockable().obtainLock(String) methods. There is one lock per EDP, which means that data can be modified in more tables (entities) in parallel.