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

com.sas.iquery.metadata.business
Interface BriefInformationMap

All Superinterfaces:

com.sas.services.information.metadata.MetadataInterface, com.sas.services.information.publicobject.PublicObjectInterface, java.rmi.Remote, com.sas.services.util.UpgradeInterface

public interface BriefInformationMap
extends com.sas.services.information.metadata.MetadataInterface, com.sas.services.util.UpgradeInterface

A thin object that represents an IQ Information Map in a repository. This thin object, when in a program's hands, does not cause the full information map to be read from the repository and populated in memory. To use the object beyond what this interface makes available you need to instantiate a full information map from the brief information map by using the InformationMapFactory.newInformationMap( ) method providing this object as input. That method reads the full map from the repository and populates its objects (data items, etc.) in memory.

The type of data a BriefInformationMap is based upon can be determined by using the getStructure() method.

See Also:

InformationMapFactory.newInformationMap(com.sas.services.session.SessionContextInterface, com.sas.iquery.metadata.IntelligentQueryMetadataServiceInterface, BriefInformationMap)

Field Summary

static java.lang.String

OBJECT_TYPE Deprecated. Use type declarations in com.sas.services.information.util.SmartTypes

Method Summary

com.sas.services.information.metadata.FolderInterface	getOwningFolder() Returns the metadata folder that contains this brief information map
StructureOfData	getStructure() Returns an indication of what type of data this information map is based upon.

Field Detail

*** This field is subject to change. ***

OBJECT_TYPE

static final java.lang.String OBJECT_TYPE

Deprecated. Use type declarations in com.sas.services.information.util.SmartTypes

The object type value for this object. This value is used on methods like com.sas.services.information.metadata.FolderInterface.getItemsByType(String)

See Also:

Constant Field Values

Method Detail

*** This method is subject to change. ***

getStructure

StructureOfData getStructure()
                             throws com.sas.services.ServiceException,
                                    java.rmi.RemoteException

Returns an indication of what type of data this information map is based upon. A BriefInformationMap not based on either relational or OLAP data will report that it is a relational information map. In the rare occasion that one needs to differentiate between an empty information map (one with no data sources) and an information map with relational data sources, one can load up the full information map and ask it for its structure.

Returns:

the structure of the information map as represented by this brief information map

Throws:

com.sas.services.ServiceException

java.rmi.RemoteException

See Also:

StructureOfData, BusinessModel.getStructure()

*** This method is subject to change. ***

getOwningFolder

com.sas.services.information.metadata.FolderInterface getOwningFolder()
                                                                      throws com.sas.services.ServiceException,
                                                                             java.rmi.RemoteException

Returns the metadata folder that contains this brief information map

Returns:

The FolderInterface object of the containing folder.

Throws:

com.sas.services.ServiceException

java.rmi.RemoteException

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