*** This interface is subject to change. ***

com.sas.iquery.metadata.business
Interface InformationMap

All Superinterfaces:

Base, BusinessModel, BusinessModelResource, BusinessModelResourceReferencer, java.util.EventListener, com.sas.iquery.metadata.business.ExtendedAttributes, Model, NamedObjectInterface, PropertyChangeListenee, java.beans.PropertyChangeListener, UsabilityInterface

public interface InformationMap
extends BusinessModel, com.sas.iquery.metadata.business.ExtendedAttributes

Specifies a business model that provides support for organizing its business items within an internal folder structure. See the BusinessModel and BusinessItem classes for information on what business items are and what they are composed of along with what types of business items are contained within a business model.

A map may be stored within a metadata repository in what are known as root trees. These trees are managed and navigated via the InformationServiceInterface. Maps found when navigating through a root tree are represented by the BriefInformationMap interface. To use the object beyond what the BriefInformationMap interface makes available, use a newInformationMap( ) method in InformationMapFactory and provide the brief information map as input. That will cause the full map to be read from the repository and have its objects (data items, etc.) populated in memory.

Field Summary

Fields inherited from interface com.sas.iquery.metadata.business.BusinessModel

EVENT_BUSINESS_ITEMS_CHANGED, EVENT_BUSINESS_RULES_CHANGED, EVENT_CHILD_ADDED, EVENT_CHILD_REMOVED, EVENT_DATA_SOURCES_CHANGED, GETOBJECTS_DEFAULT_SEARCH_CRITERIA, GETOBJECTS_INCLUDE_BASE_MODELS, GETOBJECTS_INCLUDE_HIDDEN, INVALID_ID_CHARS, SEARCH_NONRECURSIVELY, SEARCH_THRU_ALL, SEARCH_THRU_PROMPTS, SEARCH_THRU_SUBDATAITEMS, SEARCH_THRU_SUBFILTERS

Fields inherited from interface com.sas.iquery.metadata.business.Model

EVENT_DESCRIPTION_CHANGED, EVENT_ID_CHANGED, EVENT_LABEL_CHANGED, INTERMODEL_ID_DELIMITER

Fields inherited from interface com.sas.iquery.metadata.business.Base

EVENT_OBJECT_DEFINITION_CHANGED

Method Summary

java.util.Map	getAttributes() Returns this object's attributes.
BriefInformationMap	getBriefMap() Returns the BriefInformationMap this object was created from or last saved as.
java.util.List	getChangeHistory() Returns a list of ChangeHistoryItem objects associated with this InformationMap
BriefInformationMap	save(com.sas.services.information.metadata.FolderInterface folderToSaveInto, java.lang.String changeHistoryDescription) Saves this InformationMap to the specified folder and returns a BriefInformationMap that is accessible via the folder.
java.util.Map	save(com.sas.services.information.metadata.FolderInterface folderToSaveInto, java.lang.String changeHistoryDescription, java.util.Map saveOptions) Saves this InformationMap to the specified folder and returns a BriefInformationMap that is accessible via the folder.
void	setAttributes(java.util.Map attributeMap) Sets the attributes for this information map.

Methods inherited from interface com.sas.iquery.metadata.business.BusinessModel

addBusinessItem, addBusinessItem, contains, contains, generateIntraModelID, getBaseModel, getBusinessItemByID, getBusinessItemsNotInMapFolders, getChildren, getComputationalLocale, getDataLocale, getDescendents, getFamilyStateDebugString, getGroupsContaining, getMapFolderContaining, getMetadataService, getObjects, getObjects, getParentBusinessModel, getResources, getRootMapFolder, getServerProperties, getSession, getStructure, getUnresolvedResources, isIntraModelIDInUse, isLegalID, isReadOnly, isValidLabel, newBusinessGroup, newCompoundFilter, newDataItem, newDataItemReference, newDrillThroughToDetail, newFilterCascadeRule, newFilterItem, newPrompt, removeBusinessItem, removeChild, setBusinessItems, setComputationalLocale, setReadOnly, toXML, write

Methods inherited from interface com.sas.iquery.metadata.business.Model

computeModelVersion, dispose, getDescription, getID, getLabel, getLastPersistedModelVersion, setDescription, setID, setLabel

Methods inherited from interface com.sas.iquery.metadata.business.BusinessModelResource

isUnresolved

Methods inherited from interface com.sas.iquery.metadata.NamedObjectInterface

getDescription, getLabel

Methods inherited from interface com.sas.iquery.metadata.business.BusinessModelResourceReferencer

getResources

Methods inherited from interface com.sas.iquery.metadata.business.UsabilityInterface

getReasonsUnusable, isUsableInQuery

Method Detail

getBriefMap

BriefInformationMap getBriefMap()
                                throws MetadataException

Returns the BriefInformationMap this object was created from or last saved as.

Returns:

a BriefInformationMap associated with this object or null if this object has never been saved.

Throws:

MetadataException

getChangeHistory

java.util.List getChangeHistory()
                                throws MetadataException

Returns a list of ChangeHistoryItem objects associated with this InformationMap

Returns:

a (possibly empty) list of ChangeHistoryItem objects

Throws:

MetadataException

getAttributes

java.util.Map getAttributes()
                            throws MetadataException

Returns this object's attributes. The list of valid attribute names and values is not defined by this API -- only by the creator & users of these Maps. An example of one of the attributes may be "author" or "owner" of the object. All attribute names and values must be String objects of which neither are allowed to be null.

Returns:

a Map of attributes for this InformationMap.

Throws:

MetadataException

setAttributes

void setAttributes(java.util.Map attributeMap)
                   throws MetadataException

Sets the attributes for this information map. Attribute names and values must be String objects.

The attribute namespace is not defined or governed by this API, except that names starting with "SAS." are reserved for SAS Institute's use. Other users who need to set attribute are encouraged to use their company name or prefix similar to java package names.

Throws:

MetadataException

save

BriefInformationMap save(com.sas.services.information.metadata.FolderInterface folderToSaveInto,
                         java.lang.String changeHistoryDescription)
                         throws MetadataException

Saves this InformationMap to the specified folder and returns a BriefInformationMap that is accessible via the folder.

Parameters:

folderToSaveInto - -- the folder within the BIP Tree to save this map into

changeHistoryDescription - -- a description to be saved with this object.

Returns:

The BriefInformationMap object associated with this object.

Throws:

MetadataException - When the InformationMap was not saved.

java.lang.IllegalArgumentException - If the save to folder is not specified.

save

java.util.Map save(@NonNull
                   com.sas.services.information.metadata.FolderInterface folderToSaveInto,
                   java.lang.String changeHistoryDescription,
                   java.util.Map saveOptions)
                   throws MetadataException

Saves this InformationMap to the specified folder and returns a BriefInformationMap that is accessible via the folder.

Parameters:

folderToSaveInto - -- the folder within the metadata server to save this map into

changeHistoryDescription - -- a description to be saved with this object.

saveOptions - -- a java.util.Map of options describing how to save the information map. Each key in this map should be an option constant defined in this interface. Option constants defined in this interface start with "SAVEOPTION_". See the individual option constants for valid values to use in the Map.

Returns:

A Map containing the save results. Each key is a constant defined in this interface starting with "SAVERESULT_". Each save result constant describes when the constant-value pair is returned along with info on the type of value for the result constant.

Throws:

MetadataException - When the InformationMap was not saved.

java.lang.IllegalArgumentException - If the save to folder is not specified or if the save options were not validly specified

*** This interface is subject to change. ***