com.im.df.api.ddl
Class DFEntities

java.lang.Object
  com.im.df.api.ddl.DFEntities

public final class DFEntities
extends Object

Common utilities related to DFEntity.

Method Summary

static DFEntity	createJChemEntity(DFSchema schema, String entityName, DFEnvironmentRW env) A convenience method to create a new jchem base entity named `entityName' in a parent Schema.
static DFEntity	createStandardEntity(DFSchema schema, String entityName, DFEnvironmentRW env) A convenience method to create a new standard database entity named `entityName' in a parent Schema.
static boolean	isJChemEntity(DFEntity entity) Is this entity JChem type?

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

isJChemEntity

public static boolean isJChemEntity(DFEntity entity)

Is this entity JChem type?

Parameters:

entity - Entity to be tested

Returns:

true for JChem entity, false otherwise (typically standard DB table entity)

createJChemEntity

public static DFEntity createJChemEntity(DFSchema schema,
                                         String entityName,
                                         DFEnvironmentRW env)

A convenience method to create a new jchem base entity named `entityName' in a parent Schema. If the name is already used by a different entity, the next available name will be used instead. The method uses DFNewType to look up appropriate code that creates the entity. If the DFNewType cannot be found, the method throws UnsupportedOperationException. If the new type does not support the required options, it will throw IllegalArgumentException for the requested entity type.

Parameters:

schema - The parent schema

entityName - The name for the new entity

env - The execution environment with a valid DDL lock

Returns:

The instance of new entity

createStandardEntity

public static DFEntity createStandardEntity(DFSchema schema,
                                            String entityName,
                                            DFEnvironmentRW env)

A convenience method to create a new standard database entity named `entityName' in a parent Schema. If the name is already used by a different entity, the next available name will be used instead. The method uses DFNewType to look up appropriate code that creates the entity. If the DFNewType cannot be found, the method throws UnsupportedOperationException. If the new type does not support the required options, it will throw IllegalArgumentException for the requested entity type.

Parameters:

schema - The parent schema

entityName - The name for the new entity

env - The execution environment with a valid DDL lock

Returns:

The instance of new entity