com.sas.metadata.remote
Interface RelationalSchema

All Superinterfaces:

CMetadata, DeployedDataPackage, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, java.rmi.Remote, Root

All Known Subinterfaces:

DatabaseSchema, DataSourceName, SASLibrary, SecuredLibrary

public interface RelationalSchema
extends DeployedDataPackage

The abstract type that acts as the supertype for any type that can contain table objects.

Attributes of RelationalSchema are:

Associations of RelationalSchema are:

• SchemaPackage
• Tables

Usage

To create an instance of this RelationalSchema, use the factory create methods.
Example: create a RelationalSchema with name "RelationalSchema_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();
 RelationalSchema myObject = (RelationalSchema) factory.createComplexMetadataObject(objectStore, "RelationalSchema_Object", MetadataObjects.RELATIONALSCHEMA, "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_SCHEMAPACKAGE_NAME Constant used for the name of the SchemaPackage association.
static java.lang.String	ASSOCIATION_TABLES_NAME Constant used for the name of the Tables association.

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

ASSOCIATION_ALIASES_NAME, ASSOCIATION_ALIASFOR_NAME, ASSOCIATION_DEPLOYEDCOMPONENTS_NAME, ASSOCIATION_TABLECOLLECTIONS_NAME, ASSOCIATION_USEDBYPACKAGES_NAME, ASSOCIATION_USINGPACKAGES_NAME

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

ASSOCIATION_FAVORITESCONTAINERS_NAME, ATTRIBUTE_ISHIDDEN_NAME, ATTRIBUTE_PUBLICTYPE_NAME

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

abstract DatabaseCatalog	getSchemaPackage() Gets the DatabaseCatalog for SchemaPackage
abstract AssociationList	getSchemaPackages() Gets the Association list of SchemaPackages
abstract AssociationList	getSchemaPackages(boolean fGoToServer) Gets the Associationlist of SchemaPackages
abstract AssociationList	getTables() Gets the Association list of Tables
abstract AssociationList	getTables(boolean fGoToServer) Gets the Associationlist of Tables
abstract void	initializePredObjects() (S) Adds the Associated objects to the predObjects which are:
abstract void	initializeRequiredObjects() (S) This initializes the Required Objects(Roles) which are:
abstract void	setSchemaPackage(DatabaseCatalog inObject) Sets the SchemaPackages list 0th element to be inObject.
abstract void	setSchemaPackages(AssociationList list) Sets the SchemaPackages list to be list.
abstract void	setSchemaPackages(AssociationList list, int state) Sets the SchemaPackages list to be list.
abstract void	setTables(AssociationList list) Sets the Tables list to be list.
abstract void	setTables(AssociationList inObjects, int state) Sets the entire Tables list to match the passed in AssociationList, sets the state of the Tables

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

getAliases, getAliases, getAliasFor, getAliasFors, getAliasFors, getDeployedComponents, getDeployedComponents, getTableCollections, getTableCollections, getUsedByPackages, getUsedByPackages, getUsingPackages, getUsingPackages, setAliases, setAliases, setAliasFor, setAliasFors, setAliasFors, setDeployedComponents, setDeployedComponents, setTableCollections, setTableCollections, setUsedByPackages, setUsedByPackages, setUsingPackages, setUsingPackages

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

getFavoritesContainers, getFavoritesContainers, getIsHidden, getIsHiddenState, getPublicType, getPublicTypeMaxLength, getPublicTypeState, setFavoritesContainers, setFavoritesContainers, setIsHidden, setIsHidden, setIsHidden, setIsHidden, setIsHiddenState, setPublicType, setPublicType, setPublicTypeState

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_SCHEMAPACKAGE_NAME

static final java.lang.String ASSOCIATION_SCHEMAPACKAGE_NAME

Constant used for the name of the SchemaPackage association.

SchemaPackage: The database catalog where these schemas are contained.

See Also:

Constant Field Values

ASSOCIATION_TABLES_NAME

static final java.lang.String ASSOCIATION_TABLES_NAME

Constant used for the name of the Tables association.

Tables: *Unknown*

See Also:

Constant Field Values

Method Detail

initializeRequiredObjects

void initializeRequiredObjects()
                               throws java.rmi.RemoteException

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

Specified by:

initializeRequiredObjects in interface DeployedDataPackage

Specified by:

initializeRequiredObjects in interface MdObjectBaseUtil

Specified by:

initializeRequiredObjects in interface PrimaryType

Specified by:

initializeRequiredObjects in interface Root

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:

Specified by:

initializePredObjects in interface DeployedDataPackage

Specified by:

initializePredObjects in interface MdObjectBase

Specified by:

initializePredObjects in interface PrimaryType

Specified by:

initializePredObjects in interface Root

Throws:

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

getSchemaPackages

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

Gets the Association list of SchemaPackages

Returns:

The AssociationList of SchemaPackages which can be of type:
DatabaseCatalog

Throws:

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

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

getSchemaPackage

DatabaseCatalog getSchemaPackage()
                                 throws java.rmi.RemoteException,
                                        MdException

Gets the DatabaseCatalog for SchemaPackage

Returns:

The DatabaseCatalog ( null if not set ) of SchemaPackage which can be of type:
DatabaseCatalog

Throws:

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

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

getTables

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

Gets the Association list of Tables

Returns:

The AssociationList of Tables which can be of type:
DataTable
ExternalTable
RelationalTable
PhysicalTable
WorkTable
SecuredTable
QueryTable
JoinTable
TableCollection

Throws:

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

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

getSchemaPackages

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

Gets the Associationlist of SchemaPackages

Parameters:

fGoToServer - boolean Get the value from the server.

Returns:

Returns the SchemaPackages which can be of type:
DatabaseCatalog

Throws:

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

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

getTables

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

Gets the Associationlist of Tables

Parameters:

fGoToServer - boolean Get the value from the server.

Returns:

Returns the Tables which can be of type:
DataTable
ExternalTable
RelationalTable
PhysicalTable
WorkTable
SecuredTable
QueryTable
JoinTable
TableCollection

Throws:

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

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

setSchemaPackages

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

Sets the SchemaPackages list to be list. Objects of which can be of type:
DatabaseCatalog

Parameters:

list - AssociationList

Throws:

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

setSchemaPackages

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

Sets the SchemaPackages list to be list. Objects of which can be of type:
DatabaseCatalog

Parameters:

list - AssociationList

state - int

Throws:

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

setSchemaPackage

void setSchemaPackage(DatabaseCatalog inObject)
                      throws java.rmi.RemoteException

Sets the SchemaPackages list 0th element to be inObject.

Parameters:

inObject - DatabaseCatalog

Throws:

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

setTables

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

Sets the Tables list to be list. Objects of which can be of type:
DataTable
ExternalTable
RelationalTable
PhysicalTable
WorkTable
SecuredTable
QueryTable
JoinTable
TableCollection

Parameters:

list - AssociationList

Throws:

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

setTables

void setTables(AssociationList inObjects,
               int state)
               throws java.rmi.RemoteException

Sets the entire Tables list to match the passed in AssociationList, sets the state of the Tables

Parameters:

inObjects - AssociationList

state - int

Throws:

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