Uses of Interface
com.im.df.api.ddl.DFSchema
-
Packages that use DFSchema Package Description com.im.df.api API Status: 1 - Stable com.im.df.api.* and subpackages provide the core Discovery Informatics Framework (DIF) interfaces.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 DFSchema in com.im.df.api
Methods in com.im.df.api that return DFSchema Modifier and Type Method Description static DFSchema
DFSchemaProviders. connectAutomatically(DFSchemaProvider schemaProvider, com.im.commons.progress.DFFeedback aFeedback)
Automatically goes through schema connect process and returns fully-initialized schema.static DFSchema
DFSchemaProviders. connectWithUpgrades(DFSchemaProvider provider, com.im.commons.progress.DFFeedback feedback)
Connects to the schema performing all schema upgrade if necessary.DFSchema
DFSchemaProvider.State. getSchema()
Gets the IJC schema, if available. -
Uses of DFSchema in com.im.df.api.ddl
Methods in com.im.df.api.ddl that return DFSchema Modifier and Type Method Description static DFSchema
DFSchemas. find(DFItem item)
Utility method finding parent schema for anyDFItem
type.DFSchema
DFDataTree. getSchema()
Get owner of this datatree.DFSchema
DFEntity. getSchema()
Gets the IJC schema that this entity belongs to.DFSchema
DFScriptParent. getSchema()
Methods in com.im.df.api.ddl with parameters of type DFSchema 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.static boolean
DFSchemas. isSampleProject(DFSchema schema)
Tests if given schema is the Sample project schema. -
Uses of DFSchema in com.im.df.api.dml
Methods in com.im.df.api.dml that return DFSchema Modifier and Type Method Description DFSchema
DFSchemaDataProvider. getSchema()
-
Uses of DFSchema in com.im.df.api.support
Methods in com.im.df.api.support with parameters of type DFSchema Modifier and Type Method Description static DerivedNames
DerivedNames. getInstance(DFSchema schema)
default void
DFSchemaInitHandler. onConnect(DFSchema schema, java.lang.String userName)
Called on schema connect.default void
DFSchemaInitHandler. onDisconnect(DFSchema schema, java.lang.String userName)
Called on schema disconnect. -
Uses of DFSchema in com.im.df.api.util
Methods in com.im.df.api.util that return DFSchema Modifier and Type Method Description static DFSchema
DIFUtilities. connectAutomatically(DFSchemaProvider schemaProvider, com.im.commons.progress.DFFeedback aFeedback)
static DFSchema
DIFUtilities. findSchema(DFItem item)
Deprecated.useDFSchemas.find(DFItem)
instead.Methods in com.im.df.api.util with parameters of type DFSchema Modifier and Type Method Description static boolean
DIFUtilities. checkAmIOwner(DFSchema schema, java.lang.String owner)
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 com.im.commons.db.ddl.DBForeignKeyInfo
DIFUtilities. findForeignKey(DFSchema ijcSchema, com.im.commons.db.util.SchemaQualifiedName fkName)
Finds the named Foreign Key.static com.im.commons.db.ddl.DBForeignKeyInfo
DIFUtilities. findForeignKey(DFSchema ijcSchema, com.im.commons.db.util.SchemaQualifiedName table, java.lang.String[] columnNames, DIFUtilities.FKSearchType pkfk)
Finds a foreign key, which references the named columns as its PK or FK columns, depending on parametersstatic java.lang.String
DIFUtilities. getDefaultSchemaName(DFSchema schema)
static java.util.Collection<com.im.commons.db.ddl.DBForeignKeyInfo>
DIFUtilities. getForeignKeys(DFSchema ijcSchema)
Collects are FKs defined in the database schema, regardless of whether the FK is mapped to a Relationship or not.static java.lang.String
DIFUtilities. getIJCUsername(DFSchema schema)
Get the username of the IJC user or null if the user has not yet logged in.static com.im.commons.progress.DFLockable
DIFUtilities. getLockable(DFSchema item)
abstract void
DIFUtilities.SchemaReadyRunnable. schemaReady(DFSchemaProvider schemaProvider, DFSchema schema)
This method is invoked when schema is ready.
-