com.sas.services.information.browse
Interface BrowseMetadataInterface

All Known Implementing Classes:

BrowseMetadata

public interface BrowseMetadataInterface

Since:

1.1.3

Field Summary

static String	CREATE_KEY The map key to get the object's creation date.
static String	DESC_KEY The map key to get the object's description.
static String	ISAFOLDER_KEY The map key to get the indicator if the object is a folder;
static String	ISENTITYKEY_KEY The map key to get the object's Information Service entity key.
static String	KEYWORDS_KEY The map key to get the object's keywords.
static String	MEMBERS_KEY The map key to get an object's members, if it's a folder.
static String	MODIFY_KEY The map key to get the object's latest modified date.
static String	NAME_KEY The map key to get the object's name.
static String	NATIVETYPE_KEY The map key to get the repository native type (e.g., "Transformation" rather than "Report".
static String	REPOSID_KEY The map key to get the object's repository id.
static String	SMARTCLASS_KEY The map key to get the object's smart object Java class.
static String	SMARTTYPE_KEY The map key to get the object's smart object type (e.g., "Report" rather than "Transformation".
static String	SUBFOLDERS_KEY the map key to get the object's subfolders, if it's a folder.

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.

Field Detail

NAME_KEY

public static final String NAME_KEY

The map key to get the object's name.

DESC_KEY

public static final String DESC_KEY

The map key to get the object's description.

CREATE_KEY

public static final String CREATE_KEY

The map key to get the object's creation date. This should be a string-coded long.

MODIFY_KEY

public static final String MODIFY_KEY

The map key to get the object's latest modified date. This should be a string-coded long.

KEYWORDS_KEY

public static final String KEYWORDS_KEY

The map key to get the object's keywords.

SMARTTYPE_KEY

public static final String SMARTTYPE_KEY

The map key to get the object's smart object type (e.g., "Report" rather than "Transformation".

SMARTCLASS_KEY

public static final String SMARTCLASS_KEY

The map key to get the object's smart object Java class.

NATIVETYPE_KEY

public static final String NATIVETYPE_KEY

The map key to get the repository native type (e.g., "Transformation" rather than "Report".

ISENTITYKEY_KEY

public static final String ISENTITYKEY_KEY

The map key to get the object's Information Service entity key. This key can be used to fetch the "real" smart object.

MEMBERS_KEY

public static final String MEMBERS_KEY

The map key to get an object's members, if it's a folder.

SUBFOLDERS_KEY

public static final String SUBFOLDERS_KEY

the map key to get the object's subfolders, if it's a folder.

REPOSID_KEY

public static final String REPOSID_KEY

The map key to get the object's repository id.

ISAFOLDER_KEY

public static final String ISAFOLDER_KEY

The map key to get the indicator if the object is a folder;

Method Detail

getRawData

public Map getRawData()

Get the Map with the raw data for this object. This Map can be wrapped with a "smarter" object for accessing the data.

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)

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.

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()

Get the object name.

Returns:

The object name string.

getDescription

public String getDescription()

Get the object description.

Returns:

The object description string. An empty string will be returned rather than null if no description exists.

getCreateDate

public long getCreateDate()

Get the date the metadata object was created.

Returns:

A long representing the date and time the object was created.

getModifyDate

public long getModifyDate()

Get the date the metadata object was most recently changed.

Returns:

A long with the latest modification date and time for the object.

getKeywords

public List getKeywords()

Get a List of Strings with the keywords that are associated with this object.

Returns:

A List of String objects with the keywords.

getSmartType

public String getSmartType()

Get the "smart" type of this object. For instance, return "Report" rather than "Transformation".

Returns:

The smart object type of this object.

getNativeType

public String getNativeType()

Get the repository native type for this object. For instance, "Transformation" rather than "Report".

Returns:

The repository specific type for this object.

getISEntityKey

public String getISEntityKey()

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.

Returns:

The Information Service entity key.

isAFolder

public boolean isAFolder()

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.

Returns:

True if the object is a folder, false otherwise.

getMembers

public List getMembers()

Get the members if this is a folder.

Returns:

a List of BrowseMetadataInterface objects representing the members of the folder, or null if it's not a folder.

getSubfolders

public List getSubfolders()

Get the subfolders if this is a folder.

Returns:

a List of BrowsemetadataInterface objects representing the subfolders of this folder, or null if it's not a folder.

getReposId

public String getReposId()

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.

toString

public String toString()

Return a simple string representation of the object.

Overrides:

toString in class Object

Returns:

A String object representing the metadata object.