com.sas.metadata.remote
Interface OLAPSchema

All Superinterfaces:

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

public interface OLAPSchema
extends DeployedDataPackage

This is a grouping of Cubes accessible from a SAS OLAP server.

Attributes of OLAPSchema are:

Associations of OLAPSchema are:

• Cubes
• LogFile
• Dimensions

Usage

To create an instance of this OLAPSchema, use the factory create methods.
Example: create a OLAPSchema with name "OLAPSchema_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();
 OLAPSchema myObject = (OLAPSchema) factory.createComplexMetadataObject(objectStore, "OLAPSchema_Object", MetadataObjects.OLAPSCHEMA, "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_CUBES_NAME Constant used for the name of the Cubes association.
static java.lang.String	ASSOCIATION_DIMENSIONS_NAME Constant used for the name of the Dimensions association.
static java.lang.String	ASSOCIATION_LOGFILE_NAME Constant used for the name of the LogFile 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

AssociationList	getCubes() Gets the AssociationList of Cubes
AssociationList	getCubes(boolean fGoToServer) Gets the Associationlist of Cubes
AssociationList	getDimensions() Gets the Association list of Dimensions
AssociationList	getDimensions(boolean fGoToServer) Gets the Associationlist of Dimensions
File	getLogFile() Gets the File for LogFile
AssociationList	getLogFiles() Gets the AssociationList of LogFiles
AssociationList	getLogFiles(boolean fGoToServer) Gets the Associationlist of LogFiles
void	initializePredObjects() (S) Adds the Associated objects to the predObjects which are: Cubes LogFile
void	initializeRequiredObjects() (S) This initializes the Required Objects(Roles) which are:
void	setCubes(AssociationList list) Sets the Cubes list to be list.
void	setCubes(AssociationList inObjects, int state) Sets the entire AssociationList to match the passed in Vector, sets the state of the AssociationList
void	setDimensions(AssociationList list) Sets the Dimensions list to be list.
void	setDimensions(AssociationList inObjects, int state) Sets the entire Dimensions list to match the passed in AssociationList, sets the state of the Dimensions
void	setLogFile(File inObject) Sets the LogFiles list 0th element to be inObject.
void	setLogFiles(AssociationList list) Sets the LogFiles list to be list.
void	setLogFiles(AssociationList list, int state) Sets the LogFiles list to be list.

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_CUBES_NAME

static final java.lang.String ASSOCIATION_CUBES_NAME

Constant used for the name of the Cubes association.

Cubes: The cubes that are accessible through this schema.

See Also:

Constant Field Values

ASSOCIATION_LOGFILE_NAME

static final java.lang.String ASSOCIATION_LOGFILE_NAME

Constant used for the name of the LogFile association.

LogFile: The log file for this schema.

See Also:

Constant Field Values

ASSOCIATION_DIMENSIONS_NAME

static final java.lang.String ASSOCIATION_DIMENSIONS_NAME

Constant used for the name of the Dimensions association.

Dimensions: Dimensions that are contained in this schema.

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:
Cubes
LogFile

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.

getCubes

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

Gets the AssociationList of Cubes

Returns:

Returns the AssociationList of Cubes which can be of type:
Cube

Throws:

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

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

getLogFiles

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

Gets the AssociationList of LogFiles

Returns:

Returns the AssociationList of LogFiles which can be of type:
File
ArchiveFile

Throws:

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

MdException

getLogFile

File getLogFile()
                throws java.rmi.RemoteException,
                       MdException

Gets the File for LogFile

Returns:

The File ( null if not set) of LogFilewhich can be of type:
File
ArchiveFile

Throws:

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

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

getDimensions

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

Gets the Association list of Dimensions

Returns:

The AssociationList of Dimensions which can be of type:
Dimension
SharedDimension

Throws:

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

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

getCubes

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

Gets the Associationlist of Cubes

Parameters:

fGoToServer - boolean Get the value from the server.

Returns:

Returns the AssociationList of Cubes which can be of type:
Cube

Throws:

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

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

getLogFiles

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

Gets the Associationlist of LogFiles

Parameters:

fGoToServer - boolean Get the value from the server.

Returns:

Returns the AssociationList of LogFiles which can be of type:
File
ArchiveFile

Throws:

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

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

getDimensions

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

Gets the Associationlist of Dimensions

Parameters:

fGoToServer - boolean Get the value from the server.

Returns:

Returns the Dimensions which can be of type:
Dimension
SharedDimension

Throws:

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

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

setCubes

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

Sets the Cubes list to be list. Objects of which can be of type:
Cube

Parameters:

list - AssociationList

Throws:

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

setCubes

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

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

Parameters:

inObjects - AssociationList

state - int

Throws:

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

setLogFiles

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

Sets the LogFiles list to be list. Object of which can be of type:
File
ArchiveFile

Parameters:

list - AssociationList

Throws:

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

setLogFiles

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

Sets the LogFiles list to be list. Object of which can be of type:
File
ArchiveFile

Parameters:

list - AssociationList

state - int

Throws:

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

setLogFile

void setLogFile(File inObject)
                throws java.rmi.RemoteException

Sets the LogFiles list 0th element to be inObject.

Parameters:

inObject - File

Throws:

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

setDimensions

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

Sets the Dimensions list to be list. Objects of which can be of type:
Dimension
SharedDimension

Parameters:

list - AssociationList

Throws:

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

setDimensions

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

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

Parameters:

inObjects - AssociationList

state - int

Throws:

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