Uses of Interface
com.im.df.api.ddl.DFEntity
-
Packages that use DFEntity Package Description com.im.df.api.capabilities API Status: 1 - Stable Provides the interfaces that allow extension of the the core data model of Discovery Informatics Framework (DIF).com.im.df.api.chem API Status: 3 - Under development Provides the chemically oriented interfaces used in other parts of DIF.com.im.df.api.ddl API Status: 1 - Stablecom.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.com.im.df.api.support API Status: 1 - Stable Provides various support classes used by the Discovery Informatics Framework API (com.im.df.api.*).com.im.df.api.util API Status: 2 - Pretty stable Provides various utilities and convenience methods to be used on top of DIF objects. -
-
Uses of DFEntity in com.im.df.api.capabilities
Methods in com.im.df.api.capabilities with parameters of type DFEntity Modifier and Type Method Description DFTermExpression
VirtualEntityCapability. resolveIncomingRelationship(DFTermExpression expr, DFEntity from, com.im.commons.progress.DFEnvironmentRO env)
DFTermExpression
VirtualEntityCapability. resolveOutgoingRelationship(DFTermExpression expr, DFEntity to, com.im.commons.progress.DFEnvironmentRO env)
-
Uses of DFEntity in com.im.df.api.chem
Methods in com.im.df.api.chem with parameters of type DFEntity Modifier and Type Method Description default DissimilarityCalculator
DissimilarityCalculator. create(DFEntity targetEntity, chemaxon.struc.Molecule query, chemaxon.sss.search.JChemSearchOptions options, chemaxon.standardizer.Standardizer standardizer)
Creates an instance ofDissimilarityCalculator
for giventargetEntity
type.static DissimilarityCalculator
DissimilarityCalculatorFactory. create(DFEntity targetEntity, chemaxon.struc.Molecule query, chemaxon.sss.search.JChemSearchOptions options)
static DissimilarityCalculator
DissimilarityCalculatorFactory. create(DFEntity targetEntity, chemaxon.struc.Molecule query, chemaxon.sss.search.JChemSearchOptions options, chemaxon.standardizer.Standardizer standardizer)
static chemaxon.standardizer.Standardizer
ChemUtils. getStandardizer(DFEntity entity)
Gets standardizer from entity based onJChemEntityCapability
.static com.google.common.base.Optional<DFField>
ChemUtils. getStructureField(DFEntity entity)
-
Uses of DFEntity in com.im.df.api.ddl
Methods in com.im.df.api.ddl that return DFEntity Modifier and Type Method Description static DFEntity
DFEntities. createJChemEntity(DFSchema schema, java.lang.String entityName, int jchemTableType, com.im.commons.progress.DFEnvironmentRW env)
A convenience method to create a new jchem base entity named `entityName' in a parent Schema.static DFEntity
DFEntities. createJChemEntity(DFSchema schema, java.lang.String entityName, com.im.commons.progress.DFEnvironmentRW env)
A convenience method to create a new jchem base entity named `entityName' in a parent Schema.static DFEntity
DFEntities. createStandardEntity(DFSchema schema, java.lang.String entityName, com.im.commons.progress.DFEnvironmentRW env)
A convenience method to create a new standard database entity named `entityName' in a parent Schema.DFEntity
DFDataTree.Vertex. getEntity()
DFEntity
DFField. getEntity()
DFEntity
DFList. getEntity()
Get the entity which this list belongs to.Methods in com.im.df.api.ddl that return types with arguments of type DFEntity Modifier and Type Method Description DFContainer<DFEntity>
DFSchema. getEntities()
Get the entities container.DFItem.Handle<DFEntity>
DFEntity. getHandle()
Gets the handle for this entity.Methods in com.im.df.api.ddl with parameters of type DFEntity Modifier and Type Method Description static com.google.common.base.Predicate<DFField>
DFFields.Predicates. belongTo(DFEntity ent)
Returns predicate returningtrue
when the inputfield
belongs to the entity.static DFField
DFFields. createBinaryField(DFEntity entity, java.lang.String fieldName, java.lang.String columnName, com.im.commons.progress.DFEnvironmentRW env)
Create new binary standard field.static DFField
DFFields. createBooleanField(DFEntity entity, java.lang.String fieldName, java.lang.String columnName, com.im.commons.progress.DFEnvironmentRW env)
Create new boolean standard field.static DFField
DFFields. createChemTermsField(DFEntity entity, java.lang.String fieldName, com.im.commons.db.ddl.GenericColumnType fieldType, java.lang.String formula, com.im.commons.progress.DFEnvironmentRW env)
Creates a new chemical terms field inside given entity according to provided parameters.static DFDataTree
DFDataTrees. createDataTree(DFEntity rootEntity, java.lang.String dataTreeName, com.im.commons.progress.DFEnvironmentRW env)
Creates a default data tree for the entity as a root.static DFField
DFFields. createDateField(DFEntity entity, java.lang.String fieldName, java.lang.String columnName, com.im.commons.progress.DFEnvironmentRW env)
Create new date field with default column type.static DFField
DFFields. createDateField(DFEntity entity, java.lang.String fieldName, java.lang.String columnName, com.im.commons.progress.DFEnvironmentRW env, com.im.commons.db.ddl.DBDatabaseInfo.ColumnSQLType sqlType)
Create new date field with specific column type.static DFField
DFFields. createDynamicURLField(DFEntity entity, java.lang.String fieldName, java.lang.String mimeType, java.lang.String urlTemplate, DFField[] params, com.im.commons.progress.DFEnvironmentRW env)
Create a new dynamic URL field.static DFField
DFFields. createFloatField(DFEntity entity, java.lang.String fieldName, java.lang.String columnName, int size, int scale, com.im.commons.progress.DFEnvironmentRW env)
Create new float standard field with default column type.static DFField
DFFields. createIntegerField(DFEntity entity, java.lang.String fieldName, java.lang.String columnName, com.im.commons.progress.DFEnvironmentRW env)
Create new integer standard field.static DFField
DFFields. createStaticURLField(DFEntity entity, java.lang.String fieldName, java.lang.String columnName, int size, java.lang.String mimeType, com.im.commons.progress.DFEnvironmentRW env)
Create a new static URL field with default column type.static DFField
DFFields. createTextArrayField(DFEntity entity, java.lang.String fieldName, java.lang.String columnName, int size, com.im.commons.progress.DFEnvironmentRW env)
Create new text list field with default column type (VARCHAR).static DFField
DFFields. createTextField(DFEntity entity, java.lang.String fieldName, java.lang.String columnName, int size, com.im.commons.progress.DFEnvironmentRW env)
Create new text standard field with default column type (VARCHAR).static DFField
DFFields. findStructureField(DFEntity entity)
Finds Structure field if it's available.static java.util.List<? extends DFField>
DFFields. getCategoryFields(DFEntity entity)
Deprecated.useDFFields.getGroupFields(DFEntity)
instead; this method will be removed in post-5.12 releasestatic java.util.List<? extends DFField>
DFFields. getGroupFields(DFEntity entity)
Return fields belonging to the given entity which are appropriate to be used as a group field.static boolean
DFEntities. isJChemEntity(DFEntity entity)
Is this entity JChem type?static boolean
DFEntities. isMarkushJChemEntity(DFEntity entity)
Determines whether aDFEntity
is a Markush JChem entity.static boolean
DFEntities. isQueryable(DFEntity entity)
Determines whether aDFEntity
is a queryable.static boolean
DFEntities. isStructureEntity(DFEntity entity)
Is this a structure entity?static boolean
DFEntities. isVirtual(DFEntity entity)
Determines whether aDFEntity
is a virtual entity. -
Uses of DFEntity in com.im.df.api.dml
Methods in com.im.df.api.dml that return DFEntity Modifier and Type Method Description DFEntity
DFEntityDataProvider. getEntity()
Gets the entity which this EDP belongs to.static DFEntity
DFTermExpressions. getEntity(DFTermExpression expr)
Extracts entity from expression.DFEntity
DFDeleteDescription. getTargetEntity()
DFEntity
DFInsertDescription. getTargetEntity()
Methods in com.im.df.api.dml with parameters of type DFEntity Modifier and Type Method Description static DFDeleteDescription
DFDeleteDescription. create(DFEntity en, java.util.Set<java.lang.Object> idsToDelete)
static DFInsertDescription
DFInsertDescription. create(DFEntity en)
Creates DFInsertDescription that inserts data into the given Entity.static DFInsertDescription
DFInsertDescription. create(DFEntity en, java.util.Map<java.lang.String,java.lang.Object> values)
Creates DFInsertDescription that inserts data into the given Entity.DFInsertDescription
DFInsertDescription. createDescription(DFEntity target)
Creates an empty DFInsertDescription.static DFEntityDataProvider
DFEntityDataProviders. find(DFEntity ent)
Convenient delegate toentity.getSchema().getDataProvider().getEntityDataProvider(entity)
.DFEntityDataProvider
DFSchemaDataProvider. getEntityDataProvider(DFEntity entity)
java.util.List<? extends java.lang.Comparable<?>>
DFSchemaDataProvider. queryForIds(DFEntity entity, DFDataTree dataTree, DFTermExpression query, SortDirective sort, EarlyResultsConsumer consumer, com.im.commons.progress.DFEnvironmentRO env)
Gets the IDs (primary key values) of the provided entity that matches the specified query. -
Uses of DFEntity in com.im.df.api.support
Methods in com.im.df.api.support that return DFEntity Modifier and Type Method Description DFEntity
DFUpdateDescription. getEntity()
DFEntity
DFNewTypeWellKnownOptions.NewDataTree. getRootEntity()
Methods in com.im.df.api.support with parameters of type DFEntity Modifier and Type Method Description static CalcTemplate
CalcTemplate. create(java.lang.String msgFormatPattern, java.lang.String[] fieldIDs, DFEntity entity)
Creates a CalcTemplate instance for the message format and fields given by IDs.static DFUpdateDescription
DFUpdateDescription. create(DFEntity entity, java.lang.Comparable<?> rowId, java.util.Map<java.lang.String,java.lang.Object> valuesToUpdate)
Creates an update operation description for a single row ID.static DFUpdateDescription
DFUpdateDescription. create(DFEntity entity, java.util.List<? extends java.lang.Comparable<?>> rowIds, java.util.Map<java.lang.String,java.lang.Object> valuesToUpdate)
Creates an update operation description for a set of rows.java.lang.String
DerivedNames. createFieldName(java.lang.String columnName, DFEntity parent)
static DFUpdateDescription
DFUpdateDescription. createForAllIds(DFEntity entity, java.util.Map<java.lang.String,java.lang.Object> valuesToUpdate)
Creates an update operation description for updating all rows in an entity.static SortDirective
SortDirective. parse(DFEntity entity, java.lang.String value)
void
DFNewTypeWellKnownOptions.NewDataTree. setRootEntity(DFEntity rootEntity)
Constructors in com.im.df.api.support with parameters of type DFEntity Constructor Description CalculableGroovyTemplate(DFEntity ent, com.im.ijcs.api.ddl.dto.FieldInfo.Script script, java.util.Map<java.lang.String,CalculableGroovyTemplate.FieldDetails> varNameToField, java.lang.Class<?> returnType)
FieldDetails(DFEntity masterEntity, DFField field, java.lang.String relationshipId, CalculableGroovyTemplate.CalcOperation calcOperation, java.lang.String testValue, java.util.List<java.lang.String> params)
FieldDetails(DFEntity masterEntity, java.lang.String fieldId, java.lang.String relationshipId, CalculableGroovyTemplate.CalcOperation calcOperation, java.lang.String testValue, java.util.List<java.lang.String> params)
-
Uses of DFEntity in com.im.df.api.util
Methods in com.im.df.api.util that return DFEntity Modifier and Type Method Description static DFEntity
DIFUtilities. createSchemaEntity(DFSchema parent, java.lang.String entityName, java.lang.String entityType, com.im.commons.progress.DFEnvironmentRW env)
A convenience method to create a entity named `entityName' of type `entityType' in a parent Schema.static DFEntity
DIFUtilities. findEntityByFieldID(DFContainer<DFEntity> dfContainer, java.lang.String fieldId)
Return entity which contains the field with specified ID.Methods in com.im.df.api.util that return types with arguments of type DFEntity Modifier and Type Method Description static java.util.Set<DFEntity>
DIFUtilities. findAllTreeEntities(DFDataTree.Vertex vertex)
Collects all entities used in the specified vertex and its children.Methods in com.im.df.api.util with parameters of type DFEntity Modifier and Type Method Description static DFDataTree
DIFUtilities. createDataTreeForEntity(DFEntity entity, com.im.commons.progress.DFEnvironmentRW env)
Deprecated.Use @link {DFDataTrees.createDataTree(DFEntity rootEntity, String dataTreeName, DFEnvironmentRW env)}static DFField
DIFUtilities. createSchemaField(DFEntity parent, java.lang.String fieldName, java.lang.String fieldType, boolean existing, com.im.commons.progress.DFEnvironmentRW env)
A convenience method to create a field named `fieldName' of type `fieldType' in a parent Entity.static DFField
DIFUtilities. fieldForColumn(DFEntity entity, java.lang.String colName)
Finds aDFField
, that uses the named column.static DFRelationship.Direction
DIFUtilities. findDirectionFromOrigin(DFRelationship rel, DFEntity entity)
Finds the relationship direction which originates at entity 'entity'.static DFEntityDataProvider
DIFUtilities. findEntityDataProvider(DFEntity entity)
Deprecated.useDFEntityDataProviders.find(DFEntity)
insteadstatic DFDataTree.Vertex
DIFUtilities. findEntityInDataTree(DFDataTree.Vertex vertex, DFEntity entity)
Finds a vertex in the DataTree, which corresponds to the given entity.static java.util.Set<DFField>
DIFUtilities. findFieldsUsedInRelationships(DFEntity entity)
Find all fields of specified entity which participate in any relationships.static java.util.List<DFRelationship.Direction>
DIFUtilities. findOutgoingDirections(DFEntity entity)
Finds all relationship directions which originate in an entity.static java.util.List<DFDataTree.Vertex>
DIFUtilities. findUsagesInDataTrees(DFEntity entity)
Find all datatrees.vertexes which are built on top of given entity.static java.util.List<DFRelationship>
DIFUtilities. findUsagesInRelationships(DFEntity entity)
Find all relationships where the given entity participates.static com.im.commons.progress.DFLockable
DIFUtilities. getLockable(DFEntity item)
static com.im.commons.progress.DFLockable
DIFUtilities. getLockable(DFEntity item, boolean forLists)
static DFRelationship.Direction
DIFUtilities. getOutgoingDirection(DFEntity entity, DFRelationship rel)
static boolean
DIFUtilities. isEntityDataEditable(DFEntity entity, DFDataEditCapability.Type type)
Method parameters in com.im.df.api.util with type arguments of type DFEntity Modifier and Type Method Description static DFEntity
DIFUtilities. findEntityByFieldID(DFContainer<DFEntity> dfContainer, java.lang.String fieldId)
Return entity which contains the field with specified ID.
-