com.fatwire.gst.foundation.facade.mda
Class DimensionUtils

java.lang.Object
  com.fatwire.gst.foundation.facade.mda.DimensionUtils

public final class DimensionUtils
extends Object

Miscellaneous utilities for working with dimensions

Since:

Jun 8, 2009

Author:

Tony Field

Constructor Summary

DimensionUtils()

Method Summary

static Collection<com.fatwire.assetapi.data.AssetId>	filterAssets(com.fatwire.mda.DimensionManager dimensionManager, List<com.fatwire.assetapi.data.AssetId> toFilterList, Collection<com.fatwire.assetapi.data.AssetId> preferredDimensionIds, com.fatwire.mda.DimensionSetInstance dimSet) Main dimension filtering method.
static com.fatwire.mda.DimensionableAssetManager	getDAM(COM.FutureTense.Interfaces.ICS ics) Shorthand function for returning the DimensionableAssetManager given an ICS context.
static com.fatwire.assetapi.data.AssetId	getDimensionAssetIdForName(COM.FutureTense.Interfaces.ICS ics, String name) Get the AssetId of the dimension asset for the name specified
static com.fatwire.mda.DimensionFilterInstance	getDimensionFilter(com.fatwire.mda.DimensionManager dimensionManager, Collection<com.fatwire.assetapi.data.AssetId> preferredDimensionIds, com.fatwire.mda.DimensionSetInstance dimSet) Method to get a fully-populated dimension filter, given the specified input params.
static com.fatwire.mda.Dimension	getDimensionForName(COM.FutureTense.Interfaces.ICS ics, String name) Get the AssetId of the dimension asset for the name specified
static long	getDimensionIdForName(COM.FutureTense.Interfaces.ICS ics, String name) Get the id of the dimension asset for the name specified
static com.fatwire.mda.DimensionManager	getDM(COM.FutureTense.Interfaces.ICS ics) Shorthand function for returning the DimensionManager given an ICS context
static com.fatwire.mda.Dimension	getLocaleAsDimension(com.fatwire.mda.DimensionableAssetManager dam, com.fatwire.assetapi.data.AssetId id) Return the dimension of the input asset that corresponds to its locale.
static com.fatwire.mda.Dimension	getLocaleAsDimension(COM.FutureTense.Interfaces.ICS ics, com.fatwire.assetapi.data.AssetId id) Return the dimension of the input asset that corresponds to its locale.
static String	getNameForDimensionId(COM.FutureTense.Interfaces.ICS ics, long dimensionid) Shorthand function to get the name given a dimension ID specified.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DimensionUtils

public DimensionUtils()

Method Detail

getDAM

public static com.fatwire.mda.DimensionableAssetManager getDAM(COM.FutureTense.Interfaces.ICS ics)

Shorthand function for returning the DimensionableAssetManager given an ICS context.

Parameters:

ics - context

Returns:

dimensionable asset manager

getDM

public static com.fatwire.mda.DimensionManager getDM(COM.FutureTense.Interfaces.ICS ics)

Shorthand function for returning the DimensionManager given an ICS context

Parameters:

ics - context

Returns:

Dimension Manager

getLocaleAsDimension

public static com.fatwire.mda.Dimension getLocaleAsDimension(COM.FutureTense.Interfaces.ICS ics,
                                                             com.fatwire.assetapi.data.AssetId id)

Return the dimension of the input asset that corresponds to its locale. If the asset does not have a locale set, returns null

Parameters:

ics - context

id - asset

Returns:

locale dimension or null

getLocaleAsDimension

public static com.fatwire.mda.Dimension getLocaleAsDimension(com.fatwire.mda.DimensionableAssetManager dam,
                                                             com.fatwire.assetapi.data.AssetId id)

Return the dimension of the input asset that corresponds to its locale. If the asset does not have a locale set, returns null

Parameters:

id - asset

Returns:

locale dimension or null

getDimensionIdForName

public static long getDimensionIdForName(COM.FutureTense.Interfaces.ICS ics,
                                         String name)

Get the id of the dimension asset for the name specified

Parameters:

ics - context

name - dimension name, or locale

Returns:

dimension id, -1 if not found.

getDimensionAssetIdForName

public static com.fatwire.assetapi.data.AssetId getDimensionAssetIdForName(COM.FutureTense.Interfaces.ICS ics,
                                                                           String name)

Get the AssetId of the dimension asset for the name specified

Parameters:

ics - context

name - dimension name, or locale

Returns:

dimension id

getDimensionForName

public static com.fatwire.mda.Dimension getDimensionForName(COM.FutureTense.Interfaces.ICS ics,
                                                            String name)

Get the AssetId of the dimension asset for the name specified

Parameters:

ics - context

name - dimension name, or locale

Returns:

dimension id

getNameForDimensionId

public static String getNameForDimensionId(COM.FutureTense.Interfaces.ICS ics,
                                           long dimensionid)

Shorthand function to get the name given a dimension ID specified.

Parameters:

ics - context

dimensionid - ID of a locale. Note the dimension group is not verified

Returns:

dimension name, or locale name, like en_CA.

getDimensionFilter

public static com.fatwire.mda.DimensionFilterInstance getDimensionFilter(com.fatwire.mda.DimensionManager dimensionManager,
                                                                         Collection<com.fatwire.assetapi.data.AssetId> preferredDimensionIds,
                                                                         com.fatwire.mda.DimensionSetInstance dimSet)
                                                                  throws com.fatwire.mda.DimensionException

Method to get a fully-populated dimension filter, given the specified input params. This can be used for filtering.

Parameters:

dimensionManager - manager class for Dimension lookups

preferredDimensionIds - preferred dimensions to be investigated for a result. Priority preference depends on the configured filter

dimSet - DimensionSet to use for filtering.

Returns:

list of assets based on the filtering rules in the dimension filter from the specified dimension set.

Throws:

com.fatwire.mda.DimensionException - in case something goes terribly wrong.

filterAssets

public static Collection<com.fatwire.assetapi.data.AssetId> filterAssets(com.fatwire.mda.DimensionManager dimensionManager,
                                                                         List<com.fatwire.assetapi.data.AssetId> toFilterList,
                                                                         Collection<com.fatwire.assetapi.data.AssetId> preferredDimensionIds,
                                                                         com.fatwire.mda.DimensionSetInstance dimSet)
                                                                  throws com.fatwire.mda.DimensionException

Main dimension filtering method. Accesses the filter in the dimension set, configures it with the preferred dimension IDs, then filters the input assets.

Parameters:

dimensionManager - manager class for Dimension lookups

toFilterList - list of input assets that need to be filtered. Often it's just one, but a list is perfectly valid.

preferredDimensionIds - preferred dimensions to be investigated for a result. Priority preference depends on the configured filter

dimSet - DimensionSet to use for filtering.

Returns:

list of assets based on the filtering rules in the dimension filter from the specified dimension set.

Throws:

com.fatwire.mda.DimensionException - in case something goes terribly wrong.