com.sas.services.information.browse
Class BrowseMetadata

java.lang.Object
  |
  +--com.sas.services.information.browse.BrowseMetadata
All Implemented Interfaces:
BrowseMetadataInterface,

public class BrowseMetadata
extends Object
implements BrowseMetadataInterface, java.io.Serializable

See Also:
Serialized Form

Fields inherited from interface com.sas.services.information.browse.BrowseMetadataInterface
CREATE_KEY, DESC_KEY, ISAFOLDER_KEY, ISENTITYKEY_KEY, KEYWORDS_KEY, MEMBERS_KEY, MODIFY_KEY, NAME_KEY, NATIVETYPE_KEY, REPOSID_KEY, SMARTCLASS_KEY, SMARTTYPE_KEY, SUBFOLDERS_KEY
 
Constructor Summary
BrowseMetadata(Map rawData)
           
 
Method Summary
 Object get(String key)
          Get an arbitrary object from the map.
 long getCreateDate()
          Get the date the metadata object was created.
 String getDescription()
          Get the object description.
 String getISEntityKey()
          Get the Information Service entity key for this object.
 List getKeywords()
          Get a List of Strings with the keywords that are associated with this object.
 List getMembers()
          Get the members if this is a folder.
 long getModifyDate()
          Get the date the metadata object was most recently changed.
 String getName()
          Get the object name.
 String getNativeType()
          Get the repository native type for this object.
 Map getRawData()
          Get the Map with the raw data for this object.
 String getReposId()
          Get the object's repository ID.
 String getSmartType()
          Get the "smart" type of this object.
 List getSubfolders()
          Get the subfolders if this is a folder.
 boolean isAFolder()
          Returns true if this object represents a folder in the metadata.
 String toString()
          Return a simple string representation of the object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

BrowseMetadata

public BrowseMetadata(Map rawData)
Method Detail

getRawData

public Map getRawData()
Description copied from interface: BrowseMetadataInterface
Get the Map with the raw data for this object. This Map can be wrapped with a "smarter" object for accessing the data.
Specified by:
getRawData in interface BrowseMetadataInterface
Following copied from interface: com.sas.services.information.browse.BrowseMetadataInterface
Returns:
A map that represents simple attributes with String values, and associated objects as a List of Map objects.

get

public Object get(String key)
Description copied from interface: BrowseMetadataInterface
Get an arbitrary object from the map. This may be an attribute or an association. Attributes have String values, associations are represented by a List of Map objects.
Specified by:
get in interface BrowseMetadataInterface
Following copied from interface: com.sas.services.information.browse.BrowseMetadataInterface
Parameters:
key - The name of the attribute or association.
Returns:
A String representing an attribute value, or a List if key is an association.

getName

public String getName()
Description copied from interface: BrowseMetadataInterface
Get the object name.
Specified by:
getName in interface BrowseMetadataInterface
Following copied from interface: com.sas.services.information.browse.BrowseMetadataInterface
Returns:
The object name string.

getDescription

public String getDescription()
Description copied from interface: BrowseMetadataInterface
Get the object description.
Specified by:
getDescription in interface BrowseMetadataInterface
Following copied from interface: com.sas.services.information.browse.BrowseMetadataInterface
Returns:
The object description string. An empty string will be returned rather than null if no description exists.

getCreateDate

public long getCreateDate()
Description copied from interface: BrowseMetadataInterface
Get the date the metadata object was created.
Specified by:
getCreateDate in interface BrowseMetadataInterface
Following copied from interface: com.sas.services.information.browse.BrowseMetadataInterface
Returns:
A long representing the date and time the object was created.

getModifyDate

public long getModifyDate()
Description copied from interface: BrowseMetadataInterface
Get the date the metadata object was most recently changed.
Specified by:
getModifyDate in interface BrowseMetadataInterface
Following copied from interface: com.sas.services.information.browse.BrowseMetadataInterface
Returns:
A long with the latest modification date and time for the object.

getKeywords

public List getKeywords()
Description copied from interface: BrowseMetadataInterface
Get a List of Strings with the keywords that are associated with this object.
Specified by:
getKeywords in interface BrowseMetadataInterface
Following copied from interface: com.sas.services.information.browse.BrowseMetadataInterface
Returns:
A List of String objects with the keywords.

getSmartType

public String getSmartType()
Description copied from interface: BrowseMetadataInterface
Get the "smart" type of this object. For instance, return "Report" rather than "Transformation".
Specified by:
getSmartType in interface BrowseMetadataInterface
Following copied from interface: com.sas.services.information.browse.BrowseMetadataInterface
Returns:
The smart object type of this object.

getNativeType

public String getNativeType()
Description copied from interface: BrowseMetadataInterface
Get the repository native type for this object. For instance, "Transformation" rather than "Report".
Specified by:
getNativeType in interface BrowseMetadataInterface
Following copied from interface: com.sas.services.information.browse.BrowseMetadataInterface
Returns:
The repository specific type for this object.

getISEntityKey

public String getISEntityKey()
Description copied from interface: BrowseMetadataInterface
Get the Information Service entity key for this object. This key makes it easy to retrieve the "real" metadata object for this browse object so it can be updated.
Specified by:
getISEntityKey in interface BrowseMetadataInterface
Following copied from interface: com.sas.services.information.browse.BrowseMetadataInterface
Returns:
The Information Service entity key.

isAFolder

public boolean isAFolder()
Description copied from interface: BrowseMetadataInterface
Returns true if this object represents a folder in the metadata. For data in the SAS Metadata Server, being a folder doesn't necessarily imply that it's part of the BIP Tree hierarchy.
Specified by:
isAFolder in interface BrowseMetadataInterface
Following copied from interface: com.sas.services.information.browse.BrowseMetadataInterface
Returns:
True if the object is a folder, false otherwise.

getMembers

public List getMembers()
Description copied from interface: BrowseMetadataInterface
Get the members if this is a folder.
Specified by:
getMembers in interface BrowseMetadataInterface
Following copied from interface: com.sas.services.information.browse.BrowseMetadataInterface
Returns:
a List of BrowseMetadataInterface objects representing the members of the folder, or null if it's not a folder.

getSubfolders

public List getSubfolders()
Description copied from interface: BrowseMetadataInterface
Get the subfolders if this is a folder.
Specified by:
getSubfolders in interface BrowseMetadataInterface
Following copied from interface: com.sas.services.information.browse.BrowseMetadataInterface
Returns:
a List of BrowsemetadataInterface objects representing the subfolders of this folder, or null if it's not a folder.

getReposId

public String getReposId()
Description copied from interface: BrowseMetadataInterface
Get the object's repository ID. The id by itself may or may not be sufficient to actually retrieve the object from the repository, but it should at least be a unique identifier for the object within the repository. * @return The String representation of the repository identifier.
Specified by:
getReposId in interface BrowseMetadataInterface

toString

public String toString()
Description copied from interface: BrowseMetadataInterface
Return a simple string representation of the object.
Specified by:
toString in interface BrowseMetadataInterface
Overrides:
toString in class Object
Following copied from interface: com.sas.services.information.browse.BrowseMetadataInterface
Returns:
A String object representing the metadata object.




Copyright © 2006 SAS Institute Inc. All Rights Reserved.
javadoc generated Fri, 10 Feb 2006 17:28:55