Uses of Interface
com.im.df.api.ddl.DFField
-
Packages that use DFField 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 DFField in com.im.df.api.capabilities
Methods in com.im.df.api.capabilities that return DFField Modifier and Type Method Description DFField
DBFieldCapability.DBColumn. getField()
Get the field the column belongs to.DFField
DFFieldPickListCapability. getField()
DFField
JChemEntityCapability. getStructureField()
Get the structure field.Methods in com.im.df.api.capabilities that return types with arguments of type DFField Modifier and Type Method Description java.util.Set<DFField>
DFFieldExtensionCapability. fieldDependencies()
Set of fields this Extension field depends on.Methods in com.im.df.api.capabilities with parameters of type DFField Modifier and Type Method Description static DFFieldPickListCapability
DFFieldPickListCapability. getPickListIfUsed(DFField field)
Gets aDFFieldPickListCapability
instance for aDFField
.Constructors in com.im.df.api.capabilities with parameters of type DFField Constructor Description DFFieldPickListCapability(DFField field, DFFieldPickListCapability.FieldBridge fieldBridge)
-
Uses of DFField in com.im.df.api.chem
Methods in com.im.df.api.chem that return types with arguments of type DFField Modifier and Type Method Description static com.google.common.base.Optional<DFField>
ChemUtils. getStructureField(DFEntity entity)
Methods in com.im.df.api.chem with parameters of type DFField Modifier and Type Method Description static ChemUtils.MolCoreDescriptor
ChemUtils. findMolCoreDescriptor(DFTermExpression expression, DFField field)
-
Uses of DFField in com.im.df.api.ddl
Methods in com.im.df.api.ddl that return DFField Modifier and Type Method Description 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 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.DFField
DFRelationship.Direction. getDestField()
DFField
DFList. getField()
Get the field associated with this list.DFField
DFEntity. getIdField()
Gets the ID field for this entity.static DFField
DFFields. getIDField(DFResultSet.VertexState vs)
DFField
DFRelationship.Direction. getSrcField()
Methods in com.im.df.api.ddl that return types with arguments of type DFField Modifier and Type Method Description static com.google.common.base.Predicate<DFField>
DFFields.Predicates. belongTo(DFDataTree.Vertex vertex)
Returns predicate returningtrue
when the inputfield
belongs to the entity of the given vertex.static com.google.common.base.Predicate<DFField>
DFFields.Predicates. belongTo(DFEntity ent)
Returns predicate returningtrue
when the inputfield
belongs to the entity.static com.google.common.base.Predicate<DFField>
DFFields.Predicates. belongTo(DFResultSet.VertexState vs)
Returns predicate returningtrue
when the inputfield
belongs to the entity of the given vertex state.static java.util.Collection<? extends DFField>
DFFields. findDependentFields(java.util.Collection<? extends DFField> fields)
Finds calculated fields (means fields withDFFieldCalcCapability
that use the fields passed in.static java.util.List<? extends DFField>
DFFields. forVertex(DFDataTree.Vertex vertex)
static java.util.List<? extends DFField>
DFFields. forVertex(DFDataTree.Vertex vertex, boolean recursive)
static java.util.List<? extends DFField>
DFFields. forVertexState(DFResultSet.VertexState vertexState)
Getsfields
that belong to avertexState
.static java.util.List<? extends DFField>
DFFields. forVertexState(DFResultSet.VertexState vertexState, boolean recursive)
Getsfields
which belong to avertexState
and its descendants reachable recursively viaN:1
or1:1
relationships.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. getCategoryFields(java.util.List<? extends DFField> fields)
Deprecated.useDFFields.getGroupFields(List)
instead; this method will be removed in post-5.12 releaseDFContainer<DFField>
DFEntity. getFields()
Gets the fields in this entity.static 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 java.util.List<? extends DFField>
DFFields. getGroupFields(java.util.List<? extends DFField> fields)
Take the givenfields
and returns only those which are appropriate to be used as a group field.DFItem.Handle<DFField>
DFField. getHandle()
Methods in com.im.df.api.ddl with parameters of type DFField Modifier and Type Method Description 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 DFList
DFLists. createPermanentList(java.lang.String listName, DFField field, java.util.List<?> values, com.im.commons.progress.DFEnvironmentRW env)
Creates a new permanent list (DFList
.static boolean
DFFields. hasEditableValues(DFField field)
Tests if values of the given field can be edited.static boolean
DFFields. isBinary(DFField field)
Test if this field is of Binary type.static boolean
DFFields. isBoolean(DFField field)
Test if this field is of Boolean type.static boolean
DFFields. isCalculated(DFField field)
Test if this field is Calculated field.static boolean
DFFields. isChemicalTerms(DFField field)
Test if this field is Chemical terms field.static boolean
DFFields. isDate(DFField field)
Test if this field is of Date type.static boolean
DFFields. isDateTime(DFField field)
Informs whether field can store date and time or only date.static boolean
DFFields. isDBField(DFField field)
Test if this field is DB based.static boolean
DFFields. isDynamicURL(DFField field)
Test if this field is of Dynamic URL type.static boolean
DFFields. isEditableValue(DFField field)
Check whether or not data for the field in entity can be edited.static boolean
DFFields. isExtension(DFField field)
Test if this field is Extension field.static boolean
DFFields. isFloat(DFField field)
Test if this field is of a decimal number type.static boolean
DFFields. isID(DFField field)
Tests whether the given field is an ID field within its owning entity.static boolean
DFFields. isInteger(DFField field)
Test if this field is of Integer type.static boolean
DFFields. isRelationField(DFField field)
Check if column of field represents foreign key.static boolean
DFFields. isSortable(DFField field)
Informs whether the field is capable to be sorted.static boolean
DFFields. isStandard(DFField field)
Test if this field is Standard field.static boolean
DFFields. isStaticURL(DFField field)
Test if this field is of Static URL type.static boolean
DFFields. isStructure(DFField field)
Test if this field is of Structure type.static boolean
DFFields. isText(DFField field)
Test if this field is of Text type.static boolean
DFFields. isURL(DFField field)
Test if this field is of URL type.Method parameters in com.im.df.api.ddl with type arguments of type DFField Modifier and Type Method Description static java.util.Collection<? extends DFField>
DFFields. findDependentFields(java.util.Collection<? extends DFField> fields)
Finds calculated fields (means fields withDFFieldCalcCapability
that use the fields passed in.static java.util.List<? extends DFField>
DFFields. getCategoryFields(java.util.List<? extends DFField> fields)
Deprecated.useDFFields.getGroupFields(List)
instead; this method will be removed in post-5.12 releasestatic java.util.Map<java.lang.String,java.lang.Object>
DFDataTrees. getDataForFirstSelectedRow(DFDataTree dt, java.util.List<? extends DFField> fields)
Gets value(s) of first selected rows inDFResultSet.VertexState
s for given fields.static java.util.List<? extends DFField>
DFFields. getGroupFields(java.util.List<? extends DFField> fields)
Take the givenfields
and returns only those which are appropriate to be used as a group field.static java.util.List<java.lang.String>
DFFields. toNames(java.util.List<? extends DFField> fields)
Deprecated. -
Uses of DFField in com.im.df.api.dml
Methods in com.im.df.api.dml that return DFField Modifier and Type Method Description DFField
DFRelationDataException. getErrorField()
static DFField
DFTermExpressions. getField(DFTermExpression expr)
Extracts field from expression.DFField
DFTermField. getField()
Get the field which is wrapped by this DFTermField.DFField
DFInsertDescription. getLookupField()
Methods in com.im.df.api.dml that return types with arguments of type DFField Modifier and Type Method Description com.google.common.collect.ImmutableMap<DFField,DFDataTreeDataProvider.PathUpdateDescription.ValueWrapper>
DFDataTreeDataProvider.PathUpdateDescription. getValues()
Returns the field value pars from theDFDataTreeDataProvider.PathUpdateDescription
.Methods in com.im.df.api.dml with parameters of type DFField Modifier and Type Method Description DFDataTreeDataProvider.PathUpdateDescription.Builder
DFDataTreeDataProvider.PathUpdateDescription.Builder. addValue(DFField field, java.lang.Object value)
Adds new field value pair to theDFDataTreeDataProvider.PathUpdateDescription
.double[]
Operators.EqualsForDecimalsOperator. calculateBetweenValues(java.lang.Object value, DFField field)
static DFTermExpression
DFTermsFactory. createFieldOperatorValueExpr(DFOperator operator, DFField field, java.util.Map<java.lang.String,java.lang.Object> options, java.lang.Object... values)
Create the basic "Field operator Value(s)" expression.static DFResultSet.VertexState
VertexStates. findVertexState(DFResultSet.VertexState vs, DFField field)
FindsVertexState
corresponding to the given field.static java.util.List<DFOperator>
Operators. getAllStructural(DFField field)
Get the appropriate structure search operators for the JChem table type.static DFOperator
Operators. getDefaultOperatorFor(DFField field)
Returns default search operator for givenfield
.double
Operators.LeForDecimalsOperator. getHiValue(java.lang.String value, DFField field)
double
Operators.GeForDecimalsOperator. getLoValue(java.lang.String value, DFField field)
static java.util.List<DFOperator>
Operators. getOperatorsAcceptableFor(DFField field)
abstract boolean
DFOperator. isFieldAcceptableAsOperand(DFField field)
This is just an utility method which must be implemented by subclasses.boolean
Operators.AllDataOperator. isFieldAcceptableAsOperand(DFField field)
boolean
Operators.NullOperator. isFieldAcceptableAsOperand(DFField field)
boolean
Operators.SimpleFieldValuesOperator. isFieldAcceptableAsOperand(DFField field)
boolean
Operators.SimpleLogicalOperator. isFieldAcceptableAsOperand(DFField field)
boolean
Operators.StructureOperator. isFieldAcceptableAsOperand(DFField field)
abstract java.lang.Object[]
DFOperator. parseOperands(DFField field, java.lang.String operands)
java.lang.Object[]
Operators.AllDataOperator. parseOperands(DFField field, java.lang.String operands)
java.lang.Object[]
Operators.BetweenOperator. parseOperands(DFField field, java.lang.String operands)
java.lang.Object[]
Operators.ListOperator. parseOperands(DFField field, java.lang.String operands)
java.lang.Object[]
Operators.RelativeDateOperator. parseOperands(DFField field, java.lang.String operands)
java.lang.Object[]
Operators.SimpleFieldValuesOperator. parseOperands(DFField field, java.lang.String operands)
java.lang.Object[]
Operators.SimpleLogicalOperator. parseOperands(DFField field, java.lang.String operands)
java.lang.Object[]
Operators.StructureOperator. parseOperands(DFField field, java.lang.String operands)
java.util.List<? extends java.lang.Object>
DFEntityDataProvider. queryForValues(DFTermExpression query, DFField selectedField, SortDirective sort, com.im.commons.progress.DFEnvironmentRO env)
Gets the values of selectedField of the entity that match the specified query.java.util.List<?>
DFEntityDataProvider. retrieveDistinctValuesForField(DFField field, com.im.commons.progress.DFEnvironmentRO env)
Gets the List of distinct values for this field.void
DFInsertDescription. setLookupField(DFField lookupField)
Method parameters in com.im.df.api.dml with type arguments of type DFField Modifier and Type Method Description DFDataTreeDataProvider.PathUpdateDescription.Builder
DFDataTreeDataProvider.PathUpdateDescription.Builder. addValues(java.util.Map<? extends DFField,java.lang.Object> values)
Adds multiple field value pairs toDFDataTreeDataProvider.PathUpdateDescription
.java.util.Map<java.lang.Comparable<?>,java.util.Map<java.lang.String,java.lang.Object>>
DFEntityDataProvider. getData(java.util.List<? extends java.lang.Comparable<?>> ids, java.util.Set<? extends DFField> fields, com.im.commons.progress.DFEnvironmentRO env)
Fetches data for the specified IDs.java.util.Map<java.lang.Comparable<?>,java.util.Map<java.lang.String,java.lang.Object>>
DFResultSet.VertexState. getData(java.util.List<? extends java.lang.Comparable<?>> ids, java.util.Set<? extends DFField> fields, com.im.commons.progress.DFEnvironmentRO env)
Fetches data for the specified IDs.java.util.List<? extends DFRowData>
DFEntityDataProvider. queryForData(DFTermExpression query, java.util.List<? extends DFField> fields, SortDirective sort, EarlyResultsConsumer consumer, boolean filterOutNulls, com.im.commons.progress.DFEnvironmentRO env)
Deprecated.since 14.8.18 usethe variant without filterOutNulls
, the parameterfilterOutNulls
is ignored since 14.8.18 and the method always behaves as iffilterOutNulls = true
.java.util.List<? extends DFRowData>
DFEntityDataProvider. queryForData(DFTermExpression query, java.util.List<? extends DFField> fields, SortDirective sort, EarlyResultsConsumer consumer, com.im.commons.progress.DFEnvironmentRO env)
Gets the values of selected fields of the entity that match the specified query.com.google.common.collect.Table<java.lang.Comparable<?>,java.lang.String,java.lang.Object>
DFSchemaDataProvider. queryForData(DFDataTree.Vertex masterVertex, java.util.List<? extends DFField> fields, java.util.List<? extends java.lang.Comparable<?>> rowIds)
Deprecated.Constructors in com.im.df.api.dml with parameters of type DFField Constructor Description DFRelationDataException(java.lang.String msg, DFField errorField)
-
Uses of DFField in com.im.df.api.support
Methods in com.im.df.api.support that return DFField Modifier and Type Method Description DFField
DFRelationDataEvent. getChangedField()
DFField
DFNewTypeWellKnownOptions.ExistingRelationship. getDestField()
DFField
DFNewTypeWellKnownOptions.NewRelationship. getDstField()
DFField
CalculableGroovyTemplate.FieldDetails. getField()
DFField
DFNewTypeWellKnownOptions.ListUserItemDescription. getField()
DFField
DFNewTypeWellKnownOptions.NewList. getField()
DFField
DFSearchDomain. getField()
Get the field for the domain.DFField
SortDirective.Item. getField()
Gets thefield
.DFField[]
CalcTemplate. getParams()
DFField[]
Calculable. getParams()
DFField[]
CalculableGroovyTemplate. getParams()
DFField
DFNewTypeWellKnownOptions.ExistingRelationship. getSourceField()
DFField
DFNewTypeWellKnownOptions.NewRelationship. getSrcField()
Methods in com.im.df.api.support that return types with arguments of type DFField Modifier and Type Method Description java.util.List<DFField>
SortDirective. getFields()
Gets allfields
used in thisSortDirective
.Methods in com.im.df.api.support with parameters of type DFField Modifier and Type Method Description static CalcTemplate
CalcTemplate. create(java.lang.String msgFormatPattern, DFField[] params)
Creates a CalcTemplate instance for the message format and parametersstatic SortDirective
SortDirective. create(DFField[] fields, boolean[] ascendings)
static SortDirective
SortDirective. create(DFField field, boolean ascending)
static SortDirective
SortDirective. merge(SortDirective sort, DFField field, boolean ascending)
void
DFNewTypeWellKnownOptions.ExistingRelationship. setDestField(DFField f)
void
DFNewTypeWellKnownOptions.NewRelationship. setDstField(DFField dstField)
void
CalculableGroovyTemplate.FieldDetails. setField(DFField field)
void
DFNewTypeWellKnownOptions.NewList. setField(DFField field)
void
DFNewTypeWellKnownOptions.ExistingRelationship. setSourceField(DFField f)
void
DFNewTypeWellKnownOptions.NewRelationship. setSrcField(DFField srcField)
Method parameters in com.im.df.api.support with type arguments of type DFField Modifier and Type Method Description java.util.Map<java.lang.Comparable<?>,java.util.Map<java.lang.String,java.lang.Object>>
DFDao. getData(java.util.Collection<? extends java.lang.Comparable<?>> ids, java.util.List<DFField> fields)
Fetches data for given fields and the specified row IDs.static SortDirective
SortDirective. removeFields(SortDirective sort, java.lang.Iterable<? extends DFField> fields)
Removesfields
fromSortDirective
.Constructors in com.im.df.api.support with parameters of type DFField Constructor Description DFRelationDataEvent(DFRelationDataProvider source, java.util.Collection<? extends java.lang.Comparable<?>> rowIDs, DFField changedField)
DFRelationDataEvent(DFRelationDataProvider source, java.util.Collection<? extends java.lang.Comparable<?>> rowIDs, java.util.Collection<? extends java.lang.Comparable<?>> oppositeRowIDs, DFField changedField)
FieldDetails(DFEntity masterEntity, DFField field, java.lang.String relationshipId, CalculableGroovyTemplate.CalcOperation calcOperation, java.lang.String testValue, java.util.List<java.lang.String> params)
-
Uses of DFField in com.im.df.api.util
Methods in com.im.df.api.util that return DFField Modifier and Type Method Description 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.Methods in com.im.df.api.util that return types with arguments of type DFField Modifier and Type Method Description static java.util.Set<DFField>
DIFUtilities. findAllFieldsInExpression(DFTermExpression term)
static java.util.Set<DFField>
DIFUtilities. findFieldsUsedInRelationships(DFEntity entity)
Find all fields of specified entity which participate in any relationships.Methods in com.im.df.api.util with parameters of type DFField Modifier and Type Method Description static java.util.List<? extends java.lang.Object>
DIFUtilities. convertListValues(DFField sourceField, DFField targetField, java.util.List<? extends java.lang.Object> sourceValues, boolean forceValidation, com.im.commons.progress.DFEnvironmentRO env)
Converts a list ofsourceField
values to a list oftargetField
values.static java.util.List
DIFUtilities. convertValuesToCorrectType(DFField field, java.util.List values, java.lang.String listName)
Convert the list of values to correct type for the given field.static boolean[]
DIFUtilities. fieldsToSorts(DFField[] fields, boolean[] isAscendings)
static java.lang.String
DIFUtilities. findMimeType(DFField field)
static java.util.List<DFTermExpression>
DIFUtilities. findSimpleFieldUsagesInQuery(DFTermExpression term, DFField field)
static java.util.List<DFRelationship>
DIFUtilities. findUsages(DFField field)
Find all relationships where the given field participates.static com.im.commons.progress.DFLockable
DIFUtilities. getLockable(DFField item)
static boolean
DIFUtilities. isFieldValueEditable(DFField field)
Deprecated.will be removed after IJC 5.12 version.Method parameters in com.im.df.api.util with type arguments of type DFField Modifier and Type Method Description static java.util.List<DFList>
DIFUtilities. findDependentLists(java.util.List<DFField> fields)
Find all DFLists depending on given fields.Constructor parameters in com.im.df.api.util with type arguments of type DFField Constructor Description EntityDataIterator(DFEntityDataProvider edp, DFTermExpression query, java.util.Set<? extends DFField> fields, int chunkSize, com.im.commons.progress.DFEnvironmentRO env)
Creates a new instance of EntityDataIterator.
-