com.fatwire.mda

Interface DimensionableAssetManager

@Exported
public interface DimensionableAssetManager

This interface provides a mechanism for manipulating Dimensional assets.

Since:

17 mai 2006 14:58:31

Method Summary

Modifier and Type	Method and Description
Collection<Dimension>	getDimensionsForAsset(AssetId asset) Return the dimensions for the specified asset
DimensionableAssetInstance.DimensionParentRelationship	getParent(AssetId asset, String group) Get the dimensionable asset parent relationship for a given asset in a particular group
Collection<DimensionableAssetInstance.DimensionParentRelationship>	getParents(AssetId asset) Get the dimensionable asset parent relationships for a given asset
AssetId	getRelative(AssetId asset, String dimensionName) Given an identifier for an asset, retrieve the asset that is semantically equivalent to the input asset whose dimension is the specified value.
Collection<AssetId>	getRelatives(AssetId asset, com.fatwire.mda.DimensionFilterInstance filter) Given an identifier for an asset, retrieve all of the assets that are its semantic equivalents.
Collection<AssetId>	getRelatives(AssetId asset, com.fatwire.mda.DimensionFilterInstance filter, String group) Given an identifier for an asset, retrieve all of the assets that are its semantic equivalents within the specified group.
DimensionableAssetInstance	loadDimensionableAsset(AssetId id) Given a dimensionable asset id, load the asset
List<DimensionableAssetInstance>	loadDimensionableAssets(Collection<AssetId> ids) Given an input list of asset IDs, load the dimensionable assets and return the list of dimensionable assets.
void	resetParent(AssetId asset, DimensionableAssetInstance.DimensionParentRelationship oldParent, DimensionableAssetInstance.DimensionParentRelationship newParent) Reset the dimensionable asset parent relationships for an input asset with a new value.

Method Detail

getRelatives

Collection<AssetId> getRelatives(AssetId asset,
                                 com.fatwire.mda.DimensionFilterInstance filter)

Given an identifier for an asset, retrieve all of the assets that are its semantic equivalents.

Parameters:

asset - Identifier of an asset for which all relatives will be retrieved.

filter - Optional filter to constrain list of returned ids. A null value is permitted: the results will not be filtered.

Returns:

Collection of asset ids. Depending on the filter, the input asset may be present in the returned collection.

getRelatives

Collection<AssetId> getRelatives(AssetId asset,
                                 com.fatwire.mda.DimensionFilterInstance filter,
                                 String group)

Given an identifier for an asset, retrieve all of the assets that are its semantic equivalents within the specified group. This is a convenience method for further filtering relatives. Its behaviour is equivalent to calling link getRelatives(AssetId,DimensionFilterInstance) then removing assets whose dimensions are not members of the specified group.

Parameters:

asset - Identifier of an asset for which all relatives will be retrieved.

filter - Optional filter to constrain list of returned ids. A null value is permitted: the results will not be filtered.

group - Optional Dimension group that logically unites disparate dimensions

Returns:

Collection of asset ids. Depending on the filter, the input asset may be present in the returned collection.

getRelative

AssetId getRelative(AssetId asset,
                    String dimensionName)

Given an identifier for an asset, retrieve the asset that is semantically equivalent to the input asset whose dimension is the specified value.

Parameters:

asset - Identifier of an asset for which the relative will be retrieved.

dimensionName - the name of the dimension of the asset to return

Returns:

the asset ID of the relative (or the input asset id if it is already in the same dimension or null if no match is found.

Throws:

IllegalArgumentException - if the input dimension name does not exist.

getDimensionsForAsset

Collection<Dimension> getDimensionsForAsset(AssetId asset)

Return the dimensions for the specified asset

Parameters:

asset - the asset whose dimensions should be returned

Returns:

Collection dimensions for this asset

resetParent

void resetParent(AssetId asset,
                 DimensionableAssetInstance.DimensionParentRelationship oldParent,
                 DimensionableAssetInstance.DimensionParentRelationship newParent)

Reset the dimensionable asset parent relationships for an input asset with a new value.

Parameters:

asset - the asset to modify

oldParent - the parent relationship to change

newParent - the parent relationship to use

Throws:

IllegalArgumentException - if the old and new parents aren't in the same group

getParents

Collection<DimensionableAssetInstance.DimensionParentRelationship> getParents(AssetId asset)

Get the dimensionable asset parent relationships for a given asset

Parameters:

asset - the asset whose parents should be returned

Returns:

collection of parent relationships

getParent

DimensionableAssetInstance.DimensionParentRelationship getParent(AssetId asset,
                                                                 String group)

Get the dimensionable asset parent relationship for a given asset in a particular group

Parameters:

asset - the asset whose parent should be returned

group - the group the parent must belong to

Returns:

DimensionParentRelationship or null if this asset does not have a parent in this group.

loadDimensionableAssets

List<DimensionableAssetInstance> loadDimensionableAssets(Collection<AssetId> ids)

Given an input list of asset IDs, load the dimensionable assets and return the list of dimensionable assets.

Parameters:

ids - dimensionable asset ids

Returns:

list of dimensionable assets

loadDimensionableAsset

DimensionableAssetInstance loadDimensionableAsset(AssetId id)

Given a dimensionable asset id, load the asset

Parameters:

id - the id of the dimensionable asset to load

Returns:

DimensionSetInstance