Package com.im.df.api.support

API Status: 1 - Stable Provides various support classes used by the Discovery Informatics Framework API (com.im.df.api.*). All classes in this package are consider to be stable only a few of them are are documented as unstable (see javadoc of each class).

Interface Summary

Interface	Description
Calculable
DFDao	Performs the database operations for a single entity.
DFDataAcceptor	Acceptor, that can be used to test whether a certain field type accepts some data.
DFDataComparator	This interface provides an optional extension to DFDataConvertor.
DFDataConvertor	This class is supposed to handle conversion to a certain data type from multiple formats.
DFEntityDataListener	EventListener object for listening to changes of DFEntityDataProvider data.
DFFeedbackWithModalProgressDialog	This is a special extension of DFFeedback interface which allows to open modal progress dialog.
DFNewType<E extends DFItem>	NewType is the object with the ability to create new items.
DFNewTypeOptions	Generic options for all DFNewType.
DFNewTypeWellKnownOptions	All inner interfaces of this interface can be used for casting for the options objects returned from DFNewType.getOptions() method.
DFNewTypeWellKnownOptions.ClonedList	Options for newtype copying a list from a different user.
DFNewTypeWellKnownOptions.ClonedQuery	Options for newtype copying a query from a different user
DFNewTypeWellKnownOptions.ClonedScript	Options for newtype copying a script from a different user
DFNewTypeWellKnownOptions.ClonedUserItem	Just abstract super-interface for all user specific CLONE type newtypes.
DFNewTypeWellKnownOptions.ClonedView	Options for newtype copying a view from a different user
DFNewTypeWellKnownOptions.DBColumnInfo	This is just column info helper object which is used in new field options.
DFNewTypeWellKnownOptions.EntityDBOptions	Options for creating DFEntity with DBEntityCapability
DFNewTypeWellKnownOptions.EntityOptions	Options for creating any DFEntity
DFNewTypeWellKnownOptions.ExistingDBEntity	Options for creating a standard DFEntity with DBEntityCapability where database table already exists (so called promote entity).
DFNewTypeWellKnownOptions.ExistingDBField	Options for creating a DFField where database column(s) already exist (so called promoting column(s) to DFField).
DFNewTypeWellKnownOptions.ExistingJChemEntity	Options for creating a new DFEntity with JChemEntityCapability where database JChem table already exists (so called promote entity).
DFNewTypeWellKnownOptions.ExistingRelationship
DFNewTypeWellKnownOptions.FieldOptions	Options for creating any DFField
DFNewTypeWellKnownOptions.ListUserItemDescription	Special extension of DFNewTypeWellKnownOptions.UserItemDescription for lists.
DFNewTypeWellKnownOptions.NewCalulatedField	Options for creating new calculated field, you need to validate calc field by using validateScript method.
DFNewTypeWellKnownOptions.NewCTField	Options for creating a new DFField with DFFieldChemicalTermsCapability
DFNewTypeWellKnownOptions.NewDataTree	Options for creating a new DFDataTree
DFNewTypeWellKnownOptions.NewDBEntity	Options for creating a new DFEntity with DBEntityCapability
DFNewTypeWellKnownOptions.NewDBField	Options for creating a new DFField with DBFieldCapability
DFNewTypeWellKnownOptions.NewDynamicURLField	Options for creating a new DFField with DFFieldCalcCapability
DFNewTypeWellKnownOptions.NewJChemBaseEntity	Options for creating a new DFEntity with JChemEntityCapability.
DFNewTypeWellKnownOptions.NewList	Options for creating a new DFList
DFNewTypeWellKnownOptions.NewMimeTypeField	Options for creating a new DFField with DFFieldMimeTypeCapability
DFNewTypeWellKnownOptions.NewQuery	Options for creating a new DFExpression
DFNewTypeWellKnownOptions.NewRelationship	Options for creating a new DFRelationship
DFNewTypeWellKnownOptions.NewRelationshipFK
DFNewTypeWellKnownOptions.NewRelationshipMN	Extension options for M:N relationship type.
DFNewTypeWellKnownOptions.NewRelationshipSimple
DFNewTypeWellKnownOptions.NewScript	Options for creating a new DFExpression
DFNewTypeWellKnownOptions.NewSQLEntity	Option for creating SQL Entity.
DFNewTypeWellKnownOptions.NewStandardDBEntity	Options for creating a new standard DFEntity with DBEntityCapability
DFNewTypeWellKnownOptions.NewView	Options for creating a new DFView
DFNewTypeWellKnownOptions.SingleDFItem	Options for creating any single DFItem
DFNewTypeWellKnownOptions.UserItemDescription	Trivial data holder for user specific items - just for simple managing views/queries/lists from another users.
DFNewTypeWellKnownOptions.VirtualFieldOptions	Options for creating a virtual DFField (no DB column to be created)
DFRelationDataListener	Listener which monitor DFRelationDataProvider data changes.
DFSchemaInitHandler	Schema init handler.
DFSearchDomain	Search domain is a constraint when executing query in DFResultSet.
DFUndoableEdit	Undoable edit of DFUndoManager.
DFUndoManager<T extends DFUndoableEdit>	The undo/redo manager for a single undo/redo queue.
PropertiesEditingConfigurable	This is an extension of many DIF objects to provide hints to user interface code to be able to recognise what properties are editable and which are not.
PropertiesEditingConfigurable.Extra	Some elements can also provide ability to lock editing of a property for some time.
Scriptable	Script for CalculatedField.
ViewDataConsumer	ViewDataConsumer consumes data distributed by ViewDataProvider.

Class Summary

Class	Description
CalcTemplate	The template used in DFFieldCalcCapability.
CalculableGroovyTemplate	Calculable with groovy support.
CalculableGroovyTemplate.FieldDetails	A CalculableGroovyTemplate argument.
CalculationsScriptBaseClass	Custom base class that allows extra methods to be automagically injected into scripts.
DefaultValue	Represents a default value for a field.
DerivedNames	This class provides a helper, that can generate default names for DIF items.
DFEntityDataEvent	Data change event.
DFRelationDataEvent
DFServiceConfiguration	Data holder for a user service configuration.
DFUndoConfig	Deprecated. since 20.12.0
DFUpdateDescription	Description of a single data update operation.
DFUpdateInfo	Provides data about result of insert or update DIF operation.
DFUpdateResult
DFUserLoginInfo	Data holder for a single user login info.
DFUserLoginInfos	Helper utilities related to DFUserLoginInfo class.
RowSetData	Deprecated. DO NOT USE THIS STRUCTURE.
RowSetData.RelatedData	Data whose insertion has a dependency on some other data, either needing to be inserted prior to or subsequent to the data.
SelectionDescription	Generic description of selection.
SortDirective	The sorting definition for a DFDataTree.
SortDirective.Item	A single item in a SortDirective.

Enum Summary

Enum	Description
CalculableGroovyTemplate.CalcOperation
WellKnownMimeTypeXAttributes	Well known mime-types XAttributes.

Exception Summary

Exception	Description
CannotEditScriptException	Thrown when insufficient user privileges to create or edit scripts.
CannotExportDataException	Thrown when insufficient user privileges to export data.
DataModificationException
DFUndoRedoException	Undo/Redo exception
DuplicateCTFieldException	Signals that the CT field cannot be created because the entity already contains a field with the same CT formula.
IllegalItemStateException	This exception informs DIF caller, that the item being operated on is in an invalid state to perform the operation.
ObjectOwnedByOtherUserException	This exception is thrown from a DFLockable.obtainLock(java.lang.String) when the object is already locked.