com.sas.metadata.remote
Interface KeyAssociation

All Superinterfaces:

CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, java.rmi.Remote, Root, SecondaryType

public interface KeyAssociation
extends SecondaryType

Represents the relationship between two columns in a foreign key, unique key relationship. For example, if table a has a unique key of columns a1 and a2, and table b has a foreign key, of columns b1 and b2, into table a, there is a keyassociation between the columns that relate to each other, for ex. b1 to a1 and b2 to a2.

Attributes of KeyAssociation are:

Associations of KeyAssociation are:

• ForeignKeyColumn
• UniqueKeyColumn
• OwningForeignKey

Usage

To create an instance of this KeyAssociation, use the factory create methods.
Example: create a KeyAssociation with name "KeyAssociation_Object", in repository "AAAAAAAA".

 // create a store to contain your objects for this change. If you do not have an existing object
 // or store to use.  You may obtain the store from another object by using Object.getObjectStore().
 MdFactory factory; //where "factory" is a valid MdFactory instance
 MdObjectStore objectStore = factory.createObjectStore();
 KeyAssociation myObject = (KeyAssociation) factory.createComplexMetadataObject(objectStore, "KeyAssociation_Object", MetadataObjects.KEYASSOCIATION, "AAAAAAAA");
 myObject.updateMetadataAll();  // Write object to server
 objectStore.dispose();  // dispose of the object store if it is no longer needed
 

Behavior

• Attributes and associations for this object can be retrieved by using the methods in MdOMIUtil.
• When changes are made to the object, either by setting an attribute or adding objects to a particular association, they can be persisted to the metadata server with the updateMetadataAll method.
• If an object needs to be deleted, the delete method can be used. This will flag the object as being deleted on the client, and will require an update call to persist the change to the server.

Dependencies

This class depends on objects being contained in an MdObjectStore. Object stores should be disposed of when they are no longer needed as this will help clean up memory. Disposing an object store will dispose of all objects contained within that store.

Since:

9.0

Field Summary

static java.lang.String	ASSOCIATION_FOREIGNKEYCOLUMN_NAME Constant used for the name of the ForeignKeyColumn association.
static java.lang.String	ASSOCIATION_OWNINGFOREIGNKEY_NAME Constant used for the name of the OwningForeignKey association.
static java.lang.String	ASSOCIATION_UNIQUEKEYCOLUMN_NAME Constant used for the name of the UniqueKeyColumn association.

Fields inherited from interface com.sas.metadata.remote.Root

ASSOCIATION_ACCESSCONTROLS_NAME, ASSOCIATION_CHANGES_NAME, ASSOCIATION_CUSTOMASSOCIATIONS_NAME, ASSOCIATION_DOCUMENTS_NAME, ASSOCIATION_EXTENSIONS_NAME, ASSOCIATION_EXTERNALIDENTITIES_NAME, ASSOCIATION_GROUPS_NAME, ASSOCIATION_IMPLEMENTORS_NAME, ASSOCIATION_KEYWORDS_NAME, ASSOCIATION_LOCALIZEDATTRIBUTES_NAME, ASSOCIATION_NOTES_NAME, ASSOCIATION_PRIMARYPROPERTYGROUP_NAME, ASSOCIATION_PROMPTS_NAME, ASSOCIATION_PROPERTIES_NAME, ASSOCIATION_PROPERTYSETS_NAME, ASSOCIATION_REFERENCEDOBJECTS_NAME, ASSOCIATION_RESPONSIBLEPARTIES_NAME, ASSOCIATION_SOURCETRANSFORMATIONS_NAME, ASSOCIATION_SPECSOURCETRANSFORMATIONS_NAME, ASSOCIATION_SPECTARGETTRANSFORMATIONS_NAME, ASSOCIATION_TARGETTRANSFORMATIONS_NAME, ASSOCIATION_TIMESTAMPS_NAME, ASSOCIATION_TREES_NAME, ASSOCIATION_TSOBJECTNAMESPACE_NAME, ASSOCIATION_USEDBYPROTOTYPES_NAME, ASSOCIATION_USINGPROTOTYPE_NAME, ASSOCIATION_VARIABLES_NAME, ATTRIBUTE_CHANGESTATE_NAME, ATTRIBUTE_LOCKEDBY_NAME, ATTRIBUTE_USAGEVERSION_NAME

Fields inherited from interface com.sas.metadata.remote.MdObjectBase

ATTRIBUTE_DESC_NAME, ATTRIBUTE_ID_NAME, ATTRIBUTE_METADATACREATED_NAME, ATTRIBUTE_METADATAUPDATED_NAME, ATTRIBUTE_NAME_NAME

Method Summary

Column	getForeignKeyColumn() Gets the Column for ForeignKeyColumn
AssociationList	getForeignKeyColumns() Gets the AssociationList of ForeignKeyColumns
AssociationList	getForeignKeyColumns(boolean fGoToServer) Gets the Associationlist of ForeignKeyColumns
ForeignKey	getOwningForeignKey() Gets the ForeignKey for OwningForeignKey
AssociationList	getOwningForeignKeys() Gets the Association list of OwningForeignKeys
AssociationList	getOwningForeignKeys(boolean fGoToServer) Gets the Associationlist of OwningForeignKeys
Column	getUniqueKeyColumn() Gets the Column for UniqueKeyColumn
AssociationList	getUniqueKeyColumns() Gets the AssociationList of UniqueKeyColumns
AssociationList	getUniqueKeyColumns(boolean fGoToServer) Gets the Associationlist of UniqueKeyColumns
void	initializePredObjects() (S) Adds the Associated objects to the predObjects which are: ForeignKeyColumn UniqueKeyColumn
void	initializeRequiredObjects() (S) This initializes the Required Objects(Roles) which are: OwningForeignKey
void	setForeignKeyColumn(Column inObject) Sets the ForeignKeyColumns list 0th element to be inObject.
void	setForeignKeyColumns(AssociationList list) Sets the ForeignKeyColumns list to be list.
void	setForeignKeyColumns(AssociationList list, int state) Sets the ForeignKeyColumns list to be list.
void	setOwningForeignKey(ForeignKey inObject) Sets the OwningForeignKeys list 0th element to be inObject.
void	setOwningForeignKeys(AssociationList list) Sets the OwningForeignKeys list to be list.
void	setOwningForeignKeys(AssociationList list, int state) Sets the OwningForeignKeys list to be list.
void	setUniqueKeyColumn(Column inObject) Sets the UniqueKeyColumns list 0th element to be inObject.
void	setUniqueKeyColumns(AssociationList list) Sets the UniqueKeyColumns list to be list.
void	setUniqueKeyColumns(AssociationList list, int state) Sets the UniqueKeyColumns list to be list.

Methods inherited from interface com.sas.metadata.remote.Root

getAccessControls, getAccessControls, getChanges, getChanges, getChangeState, getChangeStateMaxLength, getChangeStateState, getCustomAssociations, getCustomAssociations, getDocuments, getDocuments, getExtensions, getExtensions, getExternalIdentities, getExternalIdentities, getGroups, getGroups, getImplementors, getImplementors, getKeywords, getKeywords, getLocalizedAttributes, getLocalizedAttributes, getLockedBy, getLockedByMaxLength, getLockedByState, getNotes, getNotes, getPrimaryPropertyGroup, getPrimaryPropertyGroups, getPrimaryPropertyGroups, getPrompts, getPrompts, getProperties, getProperties, getPropertySets, getPropertySets, getReferencedObjects, getReferencedObjects, getResponsibleParties, getResponsibleParties, getSourceTransformations, getSourceTransformations, getSpecSourceTransformations, getSpecSourceTransformations, getSpecTargetTransformations, getSpecTargetTransformations, getTargetTransformations, getTargetTransformations, getTimestamps, getTimestamps, getTrees, getTrees, getTSObjectNamespace, getTSObjectNamespaces, getTSObjectNamespaces, getUsageVersion, getUsageVersionState, getUsedByPrototypes, getUsedByPrototypes, getUsingPrototype, getUsingPrototypes, getUsingPrototypes, getVariables, getVariables, setAccessControls, setAccessControls, setChanges, setChanges, setChangeState, setChangeState, setChangeStateState, setCustomAssociations, setCustomAssociations, setDocuments, setDocuments, setExtensions, setExtensions, setExternalIdentities, setExternalIdentities, setGroups, setGroups, setImplementors, setImplementors, setKeywords, setKeywords, setLocalizedAttributes, setLocalizedAttributes, setLockedBy, setLockedBy, setLockedByState, setNotes, setNotes, setPrimaryPropertyGroup, setPrimaryPropertyGroups, setPrimaryPropertyGroups, setPrompts, setPrompts, setProperties, setProperties, setPropertySets, setPropertySets, setReferencedObjects, setReferencedObjects, setResponsibleParties, setResponsibleParties, setSourceTransformations, setSourceTransformations, setSpecSourceTransformations, setSpecSourceTransformations, setSpecTargetTransformations, setSpecTargetTransformations, setTargetTransformations, setTargetTransformations, setTimestamps, setTimestamps, setTrees, setTrees, setTSObjectNamespace, setTSObjectNamespaces, setTSObjectNamespaces, setUsageVersion, setUsageVersion, setUsageVersion, setUsageVersion, setUsageVersionState, setUsedByPrototypes, setUsedByPrototypes, setUsingPrototype, setUsingPrototypes, setUsingPrototypes, setVariables, setVariables

Methods inherited from interface com.sas.metadata.remote.MdObjectBaseXML

closeUpdateMetadataXML, createEmptyXML, createObjectRefreshXML, createObjectXML, createObjectXML, createUpdateAssociationXML, createUpdateAssociationXML, createUpdateSimpleXML, doCreateUpdateXML, getUpdateSimpleSubstring, updateMetadataAll

Methods inherited from interface com.sas.metadata.remote.MdObjectBaseUtil

addMdObjectListener, delete, dispose, fireMdObjectModified, getAssociatedObjects, getAssociatedObjects, getAssociatedObjects, getAssociationNames, getAssocs, getAssocsWA, getAttributeNames, getAttrs, getAttrsStates, getChangeManagementState, getChgMgtExternalIdentityImportType, getClientSideOnlyObject, getMdObjectAssociation, getPopulatedAssocs, getUpdatedAttrs, getViewList, isCheckedOut, isLocked, objectModified, removeMdObjectListener, setAttrs, setChangeManagementTargetRepository, setChgMgtExternalIdentityImportType, setClientSideOnlyObject, setMdObjectAssociation, touch, updateAssnsIds

Methods inherited from interface com.sas.metadata.remote.MdObjectBase

addElementToChangeList, clearChangeList, getChangeList, getCMetadataType, getDesc, getDescMaxLength, getDescState, getFQID, getId, getIdState, getMetadataCreated, getMetadataCreatedState, getMetadataUpdated, getMetadataUpdatedState, getName, getNameMaxLength, getNameState, getObjectStore, getPredAssociations, getRepositoryID, getRequiredAssociations, getState, isAssociationRequired, isNewObject, isPredAssociation, removeElementFromChangeList, resetObject, resetState, resetStates, setCMetadataType, setDesc, setDesc, setDescState, setFQID, setFQID, setId, setId, setIdState, setMetadataCreated, setMetadataCreated, setMetadataCreatedState, setMetadataUpdated, setMetadataUpdated, setMetadataUpdatedState, setName, setName, setNameState, setObjectStore, setState

Field Detail

ASSOCIATION_FOREIGNKEYCOLUMN_NAME

static final java.lang.String ASSOCIATION_FOREIGNKEYCOLUMN_NAME

Constant used for the name of the ForeignKeyColumn association.

ForeignKeyColumn: The columns that comprise a foreign key. Through this object, the foreign key columns are associated with the columns that comprise a particular unique key.

See Also:

Constant Field Values

ASSOCIATION_UNIQUEKEYCOLUMN_NAME

static final java.lang.String ASSOCIATION_UNIQUEKEYCOLUMN_NAME

Constant used for the name of the UniqueKeyColumn association.

UniqueKeyColumn: The column that is part of a unique key that is associated through this object with a column that is part of a foreign key.

See Also:

Constant Field Values

ASSOCIATION_OWNINGFOREIGNKEY_NAME

static final java.lang.String ASSOCIATION_OWNINGFOREIGNKEY_NAME

Constant used for the name of the OwningForeignKey association.

OwningForeignKey: The foreign key associated with this object.

See Also:

Constant Field Values

Method Detail

initializeRequiredObjects

void initializeRequiredObjects()
                               throws java.rmi.RemoteException

(S) This initializes the Required Objects(Roles) which are:
OwningForeignKey

Specified by:

initializeRequiredObjects in interface MdObjectBaseUtil

Specified by:

initializeRequiredObjects in interface Root

Specified by:

initializeRequiredObjects in interface SecondaryType

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

initializePredObjects

void initializePredObjects()
                           throws java.rmi.RemoteException

(S) Adds the Associated objects to the predObjects which are:
ForeignKeyColumn
UniqueKeyColumn

Specified by:

initializePredObjects in interface MdObjectBase

Specified by:

initializePredObjects in interface Root

Specified by:

initializePredObjects in interface SecondaryType

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getForeignKeyColumns

AssociationList getForeignKeyColumns()
                                     throws java.rmi.RemoteException,
                                            MdException

Gets the AssociationList of ForeignKeyColumns

Returns:

Returns the AssociationList of ForeignKeyColumns which can be of type:
Column
ColumnRange

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

MdException

getForeignKeyColumn

Column getForeignKeyColumn()
                           throws java.rmi.RemoteException,
                                  MdException

Gets the Column for ForeignKeyColumn

Returns:

The Column ( null if not set) of ForeignKeyColumnwhich can be of type:
Column
ColumnRange

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

MdException - If error getting/setting part of the object.

getUniqueKeyColumns

AssociationList getUniqueKeyColumns()
                                    throws java.rmi.RemoteException,
                                           MdException

Gets the AssociationList of UniqueKeyColumns

Returns:

Returns the AssociationList of UniqueKeyColumns which can be of type:
Column
ColumnRange

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

MdException

getUniqueKeyColumn

Column getUniqueKeyColumn()
                          throws java.rmi.RemoteException,
                                 MdException

Gets the Column for UniqueKeyColumn

Returns:

The Column ( null if not set) of UniqueKeyColumnwhich can be of type:
Column
ColumnRange

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

MdException - If error getting/setting part of the object.

getOwningForeignKeys

AssociationList getOwningForeignKeys()
                                     throws java.rmi.RemoteException,
                                            MdException

Gets the Association list of OwningForeignKeys

Returns:

The AssociationList of OwningForeignKeys which can be of type:
ForeignKey

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

MdException - If error getting/setting part of the object.

getOwningForeignKey

ForeignKey getOwningForeignKey()
                               throws java.rmi.RemoteException,
                                      MdException

Gets the ForeignKey for OwningForeignKey

Returns:

The ForeignKey ( null if not set ) of OwningForeignKey which can be of type:
ForeignKey

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

MdException - If error getting/setting part of the object.

getForeignKeyColumns

AssociationList getForeignKeyColumns(boolean fGoToServer)
                                     throws java.rmi.RemoteException,
                                            MdException

Gets the Associationlist of ForeignKeyColumns

Parameters:

fGoToServer - boolean Get the value from the server.

Returns:

Returns the AssociationList of ForeignKeyColumns which can be of type:
Column
ColumnRange

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

MdException - If error getting/setting part of the object.

getUniqueKeyColumns

AssociationList getUniqueKeyColumns(boolean fGoToServer)
                                    throws java.rmi.RemoteException,
                                           MdException

Gets the Associationlist of UniqueKeyColumns

Parameters:

fGoToServer - boolean Get the value from the server.

Returns:

Returns the AssociationList of UniqueKeyColumns which can be of type:
Column
ColumnRange

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

MdException - If error getting/setting part of the object.

getOwningForeignKeys

AssociationList getOwningForeignKeys(boolean fGoToServer)
                                     throws java.rmi.RemoteException,
                                            MdException

Gets the Associationlist of OwningForeignKeys

Parameters:

fGoToServer - boolean Get the value from the server.

Returns:

Returns the OwningForeignKeys which can be of type:
ForeignKey

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

MdException - If error getting/setting part of the object.

setForeignKeyColumns

void setForeignKeyColumns(AssociationList list)
                          throws java.rmi.RemoteException

Sets the ForeignKeyColumns list to be list. Object of which can be of type:
Column
ColumnRange

Parameters:

list - AssociationList

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setForeignKeyColumns

void setForeignKeyColumns(AssociationList list,
                          int state)
                          throws java.rmi.RemoteException

Sets the ForeignKeyColumns list to be list. Object of which can be of type:
Column
ColumnRange

Parameters:

list - AssociationList

state - int

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setForeignKeyColumn

void setForeignKeyColumn(Column inObject)
                         throws java.rmi.RemoteException

Sets the ForeignKeyColumns list 0th element to be inObject.

Parameters:

inObject - Column

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setUniqueKeyColumns

void setUniqueKeyColumns(AssociationList list)
                         throws java.rmi.RemoteException

Sets the UniqueKeyColumns list to be list. Object of which can be of type:
Column
ColumnRange

Parameters:

list - AssociationList

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setUniqueKeyColumns

void setUniqueKeyColumns(AssociationList list,
                         int state)
                         throws java.rmi.RemoteException

Sets the UniqueKeyColumns list to be list. Object of which can be of type:
Column
ColumnRange

Parameters:

list - AssociationList

state - int

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setUniqueKeyColumn

void setUniqueKeyColumn(Column inObject)
                        throws java.rmi.RemoteException

Sets the UniqueKeyColumns list 0th element to be inObject.

Parameters:

inObject - Column

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setOwningForeignKeys

void setOwningForeignKeys(AssociationList list)
                          throws java.rmi.RemoteException

Sets the OwningForeignKeys list to be list. Objects of which can be of type:
ForeignKey

Parameters:

list - AssociationList

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setOwningForeignKeys

void setOwningForeignKeys(AssociationList list,
                          int state)
                          throws java.rmi.RemoteException

Sets the OwningForeignKeys list to be list. Objects of which can be of type:
ForeignKey

Parameters:

list - AssociationList

state - int

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setOwningForeignKey

void setOwningForeignKey(ForeignKey inObject)
                         throws java.rmi.RemoteException

Sets the OwningForeignKeys list 0th element to be inObject.

Parameters:

inObject - ForeignKey

Throws:

java.rmi.RemoteException - If error communicating with remote object.