com.metamatrix.metadata.runtime.api
Interface VirtualDatabaseFactory

public interface VirtualDatabaseFactory

Interface that allows a VirtualDatabaseLoader implementation to create runtime metadata objects for a virtual database.

Since:

3.1

Field Summary

static java.lang.String	DEFAULT_ALIAS
static int	DEFAULT_CHAR_OCTET_LENGTH
static java.lang.String	DEFAULT_DESC
static java.lang.String	DEFAULT_FORMAT
static boolean	DEFAULT_IS_AUTO_INCREMENTED
static boolean	DEFAULT_IS_CASE_SENSITIVE
static boolean	DEFAULT_IS_CURRENCY
static boolean	DEFAULT_IS_FIXED_LENGTH
static boolean	DEFAULT_IS_NULLABLE
static boolean	DEFAULT_IS_SIGNED
static java.lang.String	DEFAULT_LABEL
static int	DEFAULT_LENGTH
static java.lang.String	DEFAULT_MAX_RANGE
static java.lang.String	DEFAULT_MIN_RANGE
static Multiplicity	DEFAULT_MULTIPLICITY
static short	DEFAULT_NULL_TYPE
static int	DEFAULT_POSITION_IN_GROUP
static int	DEFAULT_PRECISION_LENGTH
static java.util.Properties	DEFAULT_PROPERTIES
static int	DEFAULT_RADIX
static int	DEFAULT_SCALE
static short	DEFAULT_SEARCH_TYPE
static boolean	DEFAULT_SUPPORTS_SELECT
static boolean	DEFAULT_SUPPORTS_SET
static boolean	DEFAULT_SUPPORTS_SUBSCRIPTION
static boolean	DEFAULT_SUPPORTS_UPDATE
static java.lang.String	DEFAULT_VALUE

Method Summary

void	addElementsInKey(Key key, Element[] elementsInKey)
Key	createAccessPattern(GroupID groupId, java.lang.String name)
Element	createElement(GroupID groupId, java.lang.String name, int positionInGroup, java.lang.String dataTypeName, java.lang.String alias, java.lang.String desc, java.lang.String label, int length, java.lang.String defaultValue, java.lang.String format, java.lang.String maxRange, java.lang.String minRange, Multiplicity multiplicity, short nullType, short searchType, int radix, int scale, int precisionLength, int charOctetLength, boolean isAutoIncremented, boolean isCaseSensitive, boolean isCurrency, boolean isLengthFixed, boolean isSigned, boolean supportsSelect, boolean supportsSet, boolean supportsSubscription, boolean supportsUpdate, java.util.Properties props)
Element	createElement(GroupID groupId, java.lang.String name, java.lang.String dataTypeName)
Key	createForeignKey(GroupID groupId, java.lang.String name, Key primaryKey)
Group	createGroup(java.lang.String fullnameWithinModel)
Key	createKey(GroupID groupId, java.lang.String name, short keyType) Create a Key instance of the specified type
VirtualDatabaseLoaderProperties	createLoaderProperties()
Procedure	createProcedure()
Key	createUniqueKey(GroupID groupId, java.lang.String name, boolean isPrimary)
java.lang.String	getDelimiter()
void	setAlias(Element element, java.lang.String alias)
void	setAlias(Group group, java.lang.String alias)
void	setCharOctetLength(Element element, int charOctetLength)
void	setDataTypeName(Element element, java.lang.String dataTypeName)
void	setDefaultValue(Element element, java.lang.String defaultValue)
void	setDescription(Element element, java.lang.String description)
void	setDescription(Group group, java.lang.String description)
void	setFormat(Element element, java.lang.String format)
void	setIsAutoIncremented(Element element, boolean isAutoIncremented)
void	setIsCaseSensitive(Element element, boolean isCaseSensitive)
void	setIsCurrency(Element element, boolean isCurrency)
void	setIsLengthFixed(Element element, boolean isLengthFixed)
void	setIsSigned(Element element, boolean isSigned)
void	setLabel(Element element, java.lang.String label)
void	setLength(Element element, int length)
void	setMaxRange(Element element, java.lang.String maxRange)
void	setMinRange(Element element, java.lang.String minRange)
void	setMultiplicity(Element element, Multiplicity multiplicity)
void	setNullType(Element element, short nullType)
void	setPositionInGroup(Element element, int positionInGroup)
void	setPrecisionLength(Element element, int precisionLength)
void	setProperties(Element element, java.util.Properties props)
void	setRadix(Element element, int radix)
void	setScale(Element element, int scale)
void	setSearchType(Element element, short searchType)
void	setSupportsSelect(Element element, boolean supportsSelect)
void	setSupportsSet(Element element, boolean supportsSet)
void	setSupportsSubscription(Element element, boolean supportsSubscription)
void	setSupportsUpdate(Element element, boolean supportsUpdate)

Field Detail

DEFAULT_POSITION_IN_GROUP

static final int DEFAULT_POSITION_IN_GROUP

See Also:

Constant Field Values

DEFAULT_ALIAS

static final java.lang.String DEFAULT_ALIAS

DEFAULT_DESC

static final java.lang.String DEFAULT_DESC

DEFAULT_LABEL

static final java.lang.String DEFAULT_LABEL

DEFAULT_LENGTH

static final int DEFAULT_LENGTH

See Also:

Constant Field Values

DEFAULT_VALUE

static final java.lang.String DEFAULT_VALUE

DEFAULT_FORMAT

static final java.lang.String DEFAULT_FORMAT

DEFAULT_MAX_RANGE

static final java.lang.String DEFAULT_MAX_RANGE

DEFAULT_MIN_RANGE

static final java.lang.String DEFAULT_MIN_RANGE

DEFAULT_MULTIPLICITY

static final Multiplicity DEFAULT_MULTIPLICITY

DEFAULT_NULL_TYPE

static final short DEFAULT_NULL_TYPE

See Also:

Constant Field Values

DEFAULT_SEARCH_TYPE

static final short DEFAULT_SEARCH_TYPE

See Also:

Constant Field Values

DEFAULT_RADIX

static final int DEFAULT_RADIX

See Also:

Constant Field Values

DEFAULT_SCALE

static final int DEFAULT_SCALE

See Also:

Constant Field Values

DEFAULT_PRECISION_LENGTH

static final int DEFAULT_PRECISION_LENGTH

See Also:

Constant Field Values

DEFAULT_CHAR_OCTET_LENGTH

static final int DEFAULT_CHAR_OCTET_LENGTH

See Also:

Constant Field Values

DEFAULT_IS_AUTO_INCREMENTED

static final boolean DEFAULT_IS_AUTO_INCREMENTED

See Also:

Constant Field Values

DEFAULT_IS_CASE_SENSITIVE

static final boolean DEFAULT_IS_CASE_SENSITIVE

See Also:

Constant Field Values

DEFAULT_IS_CURRENCY

static final boolean DEFAULT_IS_CURRENCY

See Also:

Constant Field Values

DEFAULT_IS_FIXED_LENGTH

static final boolean DEFAULT_IS_FIXED_LENGTH

See Also:

Constant Field Values

DEFAULT_IS_SIGNED

static final boolean DEFAULT_IS_SIGNED

See Also:

Constant Field Values

DEFAULT_SUPPORTS_SELECT

static final boolean DEFAULT_SUPPORTS_SELECT

See Also:

Constant Field Values

DEFAULT_SUPPORTS_SET

static final boolean DEFAULT_SUPPORTS_SET

See Also:

Constant Field Values

DEFAULT_SUPPORTS_SUBSCRIPTION

static final boolean DEFAULT_SUPPORTS_SUBSCRIPTION

See Also:

Constant Field Values

DEFAULT_SUPPORTS_UPDATE

static final boolean DEFAULT_SUPPORTS_UPDATE

See Also:

Constant Field Values

DEFAULT_IS_NULLABLE

static final boolean DEFAULT_IS_NULLABLE

See Also:

Constant Field Values

DEFAULT_PROPERTIES

static final java.util.Properties DEFAULT_PROPERTIES

Method Detail

createAccessPattern

Key createAccessPattern(GroupID groupId,
                        java.lang.String name)
                        throws VirtualDatabaseException

Throws:

VirtualDatabaseException

Since:

3.1

createElement

Element createElement(GroupID groupId,
                      java.lang.String name,
                      int positionInGroup,
                      java.lang.String dataTypeName,
                      java.lang.String alias,
                      java.lang.String desc,
                      java.lang.String label,
                      int length,
                      java.lang.String defaultValue,
                      java.lang.String format,
                      java.lang.String maxRange,
                      java.lang.String minRange,
                      Multiplicity multiplicity,
                      short nullType,
                      short searchType,
                      int radix,
                      int scale,
                      int precisionLength,
                      int charOctetLength,
                      boolean isAutoIncremented,
                      boolean isCaseSensitive,
                      boolean isCurrency,
                      boolean isLengthFixed,
                      boolean isSigned,
                      boolean supportsSelect,
                      boolean supportsSet,
                      boolean supportsSubscription,
                      boolean supportsUpdate,
                      java.util.Properties props)
                      throws VirtualDatabaseException

Throws:

VirtualDatabaseException

Since:

3.1

createUniqueKey

Key createUniqueKey(GroupID groupId,
                    java.lang.String name,
                    boolean isPrimary)
                    throws VirtualDatabaseException

Throws:

VirtualDatabaseException

Since:

3.1

createForeignKey

Key createForeignKey(GroupID groupId,
                     java.lang.String name,
                     Key primaryKey)
                     throws VirtualDatabaseException

Throws:

VirtualDatabaseException

Since:

3.1

createKey

Key createKey(GroupID groupId,
              java.lang.String name,
              short keyType)
              throws VirtualDatabaseException

Create a Key instance of the specified type

Parameters:

groupId - the identifier for the parent Group

name - the name of the key

keyType - one of the types defined in com.metamatrix.metadata.runtime.api.MetadataConstants.KEY_TYPES

Throws:

VirtualDatabaseException

Since:

3.1

addElementsInKey

void addElementsInKey(Key key,
                      Element[] elementsInKey)
                      throws VirtualDatabaseException

Throws:

VirtualDatabaseException

Since:

3.1

createLoaderProperties

VirtualDatabaseLoaderProperties createLoaderProperties()
                                                       throws VirtualDatabaseException

Throws:

VirtualDatabaseException

Since:

3.1

createGroup

Group createGroup(java.lang.String fullnameWithinModel)
                  throws VirtualDatabaseException

Throws:

VirtualDatabaseException

Since:

3.1

setDescription

void setDescription(Group group,
                    java.lang.String description)
                    throws VirtualDatabaseException

Throws:

VirtualDatabaseException

Since:

3.1

createProcedure

Procedure createProcedure()

Since:

3.1

getDelimiter

java.lang.String getDelimiter()

Since:

3.1

createElement

Element createElement(GroupID groupId,
                      java.lang.String name,
                      java.lang.String dataTypeName)
                      throws VirtualDatabaseException

Throws:

VirtualDatabaseException

Since:

3.1

setPositionInGroup

void setPositionInGroup(Element element,
                        int positionInGroup)
                        throws VirtualDatabaseException

Throws:

VirtualDatabaseException

Since:

3.1

setDataTypeName

void setDataTypeName(Element element,
                     java.lang.String dataTypeName)
                     throws VirtualDatabaseException

Throws:

VirtualDatabaseException

Since:

3.1

setAlias

void setAlias(Element element,
              java.lang.String alias)
              throws VirtualDatabaseException

Throws:

VirtualDatabaseException

Since:

3.1

setDescription

void setDescription(Element element,
                    java.lang.String description)
                    throws VirtualDatabaseException

Throws:

VirtualDatabaseException

Since:

3.1

setLabel

void setLabel(Element element,
              java.lang.String label)
              throws VirtualDatabaseException

Throws:

VirtualDatabaseException

Since:

3.1

setLength

void setLength(Element element,
               int length)
               throws VirtualDatabaseException

Throws:

VirtualDatabaseException

Since:

3.1

setDefaultValue

void setDefaultValue(Element element,
                     java.lang.String defaultValue)
                     throws VirtualDatabaseException

Throws:

VirtualDatabaseException

Since:

3.1

setFormat

void setFormat(Element element,
               java.lang.String format)
               throws VirtualDatabaseException

Throws:

VirtualDatabaseException

Since:

3.1

setMaxRange

void setMaxRange(Element element,
                 java.lang.String maxRange)
                 throws VirtualDatabaseException

Throws:

VirtualDatabaseException

Since:

3.1

setMinRange

void setMinRange(Element element,
                 java.lang.String minRange)
                 throws VirtualDatabaseException

Throws:

VirtualDatabaseException

Since:

3.1

setMultiplicity

void setMultiplicity(Element element,
                     Multiplicity multiplicity)
                     throws VirtualDatabaseException

Throws:

VirtualDatabaseException

Since:

3.1

setNullType

void setNullType(Element element,
                 short nullType)
                 throws VirtualDatabaseException

Throws:

VirtualDatabaseException

Since:

3.1

setSearchType

void setSearchType(Element element,
                   short searchType)
                   throws VirtualDatabaseException

Throws:

VirtualDatabaseException

Since:

3.1

setRadix

void setRadix(Element element,
              int radix)
              throws VirtualDatabaseException

Throws:

VirtualDatabaseException

Since:

3.1

setScale

void setScale(Element element,
              int scale)
              throws VirtualDatabaseException

Throws:

VirtualDatabaseException

Since:

3.1

setPrecisionLength

void setPrecisionLength(Element element,
                        int precisionLength)
                        throws VirtualDatabaseException

Throws:

VirtualDatabaseException

Since:

3.1

setCharOctetLength

void setCharOctetLength(Element element,
                        int charOctetLength)
                        throws VirtualDatabaseException

Throws:

VirtualDatabaseException

Since:

3.1

setIsAutoIncremented

void setIsAutoIncremented(Element element,
                          boolean isAutoIncremented)
                          throws VirtualDatabaseException

Throws:

VirtualDatabaseException

Since:

3.1

setIsCaseSensitive

void setIsCaseSensitive(Element element,
                        boolean isCaseSensitive)
                        throws VirtualDatabaseException

Throws:

VirtualDatabaseException

Since:

3.1

setIsCurrency

void setIsCurrency(Element element,
                   boolean isCurrency)
                   throws VirtualDatabaseException

Throws:

VirtualDatabaseException

Since:

3.1

setIsLengthFixed

void setIsLengthFixed(Element element,
                      boolean isLengthFixed)
                      throws VirtualDatabaseException

Throws:

VirtualDatabaseException

Since:

3.1

setIsSigned

void setIsSigned(Element element,
                 boolean isSigned)
                 throws VirtualDatabaseException

Throws:

VirtualDatabaseException

Since:

3.1

setSupportsSelect

void setSupportsSelect(Element element,
                       boolean supportsSelect)
                       throws VirtualDatabaseException

Throws:

VirtualDatabaseException

Since:

3.1

setSupportsSet

void setSupportsSet(Element element,
                    boolean supportsSet)
                    throws VirtualDatabaseException

Throws:

VirtualDatabaseException

Since:

3.1

setSupportsSubscription

void setSupportsSubscription(Element element,
                             boolean supportsSubscription)
                             throws VirtualDatabaseException

Throws:

VirtualDatabaseException

Since:

3.1

setSupportsUpdate

void setSupportsUpdate(Element element,
                       boolean supportsUpdate)
                       throws VirtualDatabaseException

Throws:

VirtualDatabaseException

Since:

3.1

setProperties

void setProperties(Element element,
                   java.util.Properties props)
                   throws VirtualDatabaseException

Throws:

VirtualDatabaseException

Since:

3.1

setAlias

void setAlias(Group group,
              java.lang.String alias)
              throws VirtualDatabaseException

Throws:

VirtualDatabaseException

Since:

3.1