com.fatwire.assetapi.data

Class AssetFacadeImpl

java.lang.Object

com.fatwire.assetapi.data.AssetFacadeImpl

All Implemented Interfaces:

AssetFacade

@Exported
public class AssetFacadeImpl
extends Object
implements AssetFacade

Constructor Summary

Constructors

Constructor and Description
AssetFacadeImpl(ICS ics)

Method Summary

Modifier and Type	Method and Description
protected Object	evaluateProfileExpression(String profileName, Map<String,Object> profileValues, String pattern) Evaluate the profile expression value against the profile data, returning the profile value.
List<AssetResultRow>	executeContentQuery(String siteName, Long assetId, String assetName, int limit, String sortingField, boolean ascending) Execute a ContentQuery to retrieve the results.
AssetId	filterSingleAsset(AssetId asset, String desiredLocale, String dimensionSetName) Filter an asset based on a DimensionSet and a preferred locale.
List<String>	getAllAssociations(AssetId id) Get a list of all defined associations for a given asset.
List<String>	getAllAttributes(AssetId id) Get a list of all defined attributes back for given asset id.
AssetId	getAssetByName(String siteName, String assetType, String assetName) Retrieve an asset id from an asset name; for the possible multiple returns (assets with same names), we will return the first asset from the list.
protected String	getExpressionForProfileName(String valueSource, String profileName) Returns the appropriate expression for the given profileName from the valueSource field of the visitor attribute.
String	getField(String assettype, String id, String fieldName) Get a field for a given asset type and id.
String	getICSVar(String name) Get an ICS variable given name.
List<AssetId>	getImmediateChildren(String siteName, AssetId assetId) Get the immediate children of a given flex parent asset.
Long	getPublicationId(String assetName) Get the publication id given a publication name.
List<RecommendedAssetId>	getRecommendations(String recommendationName, String visitorId, String profileName, Map<String,Object> profile, String segments, String sitename, boolean keepSegments) Get a list of recommended assets.
AssetId	getRelative(AssetId asset, String locale) Get a relative of a given asset using the preferred locale.
Collection<AssetId>	getRelatives(AssetId assetId) Retrieve the relatives of a given asset in a Collection.
List<AssetId>	getSegments(String alias, String profileName, Map<String,Object> profile, String sitename) Get the segments that the visitor belongs to with visitor alias and visitor attributes.
String	getSubtype(AssetId asset) Get the subtype for a given asset.
boolean	isAssetInSite(AssetId asset, String site)
boolean	isAttributeExist(AssetData assetData, String attribute) Check if an Attribute exist in current assetData.
boolean	isValid(AssetId id, Date date) Check an asset is valid or not for a given date.
String	makeBlobLink(BlobLinkInfo linkInfo) Generate a blob link given table, identifierColumnName, identifier, and columnname with given BlobLinkInfo
String	makeLink(LinkInfo linkInfo) Generate a link given asset, template name, and LinkInfo.
protected void	populateScalarDataFromProfile(com.openmarket.gator.interfaces.IVisitorDataManager vdm, String profileName, Map<String,Object> profileData, Long siteId, Map<String,String> scalarAttributesSet) Populates ScalarVars data from the given profile.
String	processEmbeddedLink(InputStream data) Process the embeddedLink inside a binary attribute and return the processed result.
String	processEmbeddedLink(String data) Process the embeddedLink inside a String/Text attribute and return the processed result.
AssetData	read(AssetId assetId, List<String> attributes) Reads given set attribute data and returns an AssetData instance containing them.
Iterable<AssetData>	read(List<AssetId> assetIds, boolean immediateOnly) Read a list of AssetData given a list of AssetIds.
void	recordBlobDependency(String blobkey, String depns)
protected void	restoreVisitorAttributes(com.openmarket.gator.interfaces.IVisitorDataManager vdm, Map<String,String> scalarAttributesSet)
List<AssetId>	retainSegments(String alias, String profileName, Map<String,Object> profile, String segments, String sitename) Get the segments from the specified list that the visitor belongs to with visitor alias and visitor attributes

Methods inherited from class java.lang.Object

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

Constructor Detail

AssetFacadeImpl

public AssetFacadeImpl(ICS ics)

Method Detail

read

public Iterable<AssetData> read(List<AssetId> assetIds,
                                boolean immediateOnly)
                         throws AssetAccessException

Description copied from interface: AssetFacade

Read a list of AssetData given a list of AssetIds.

Specified by:

read in interface AssetFacade

Parameters:

assetIds - The list of asset ids to read.

Returns:

Iterable of asset data.

Throws:

AssetAccessException - Rethrown exception.

read

public AssetData read(AssetId assetId,
                      List<String> attributes)
               throws AssetAccessException

Description copied from interface: AssetFacade

Reads given set attribute data and returns an AssetData instance containing them.

Specified by:

read in interface AssetFacade

Parameters:

assetId - AssetId to read attributes for.

attributes - Names of the attributes.

Returns:

AssetData Containing values for requested attributes.

Throws:

AssetAccessException - Is thrown if the AssetId does not exist or attribute names passed are incorrect for the asset. AssetAccessException also wraps any AssetExceptions thrown by the internal implementation.

getAllAttributes

public List<String> getAllAttributes(AssetId id)

Description copied from interface: AssetFacade

Get a list of all defined attributes back for given asset id.

Specified by:

getAllAttributes in interface AssetFacade

Parameters:

id - The asset ID to get attributes for.

Returns:

The list of attributes names.

getAllAssociations

public List<String> getAllAssociations(AssetId id)

Description copied from interface: AssetFacade

Get a list of all defined associations for a given asset.

Specified by:

getAllAssociations in interface AssetFacade

Parameters:

id - The asset id to get attributes for.

Returns:

The list of association names.

getICSVar

public String getICSVar(String name)

Description copied from interface: AssetFacade

Get an ICS variable given name.

Specified by:

getICSVar in interface AssetFacade

Parameters:

name - The name of the ICS variable.

Returns:

The value for the ICS variable.

getField

public String getField(String assettype,
                       String id,
                       String fieldName)

Description copied from interface: AssetFacade

Get a field for a given asset type and id.

Specified by:

getField in interface AssetFacade

Parameters:

assettype - The asset type.

id - The ID of the asset.

fieldName - The name of the field to get value for.

Returns:

The value for the given field of the given asset.

getSubtype

public String getSubtype(AssetId asset)
                  throws AssetAccessException

Description copied from interface: AssetFacade

Get the subtype for a given asset.

Specified by:

getSubtype in interface AssetFacade

Parameters:

asset - The asset id.

Returns:

The subtype name.

Throws:

AssetAccessException - an AssetAccessException

isValid

public boolean isValid(AssetId id,
                       Date date)

Description copied from interface: AssetFacade

Check an asset is valid or not for a given date.

Specified by:

isValid in interface AssetFacade

Parameters:

id - The asset ID.

date - The date of interest.

Returns:

true If the asset is valid in the given date, false otherwise.

getRelative

public AssetId getRelative(AssetId asset,
                           String locale)

Description copied from interface: AssetFacade

Get a relative of a given asset using the preferred locale.

Specified by:

getRelative in interface AssetFacade

Parameters:

asset - The asset.

locale - The interested locale.

Returns:

The id for the given locale relative.

makeLink

public String makeLink(LinkInfo linkInfo)
                throws AssetAccessException

Description copied from interface: AssetFacade

Generate a link given asset, template name, and LinkInfo.

Specified by:

makeLink in interface AssetFacade

Parameters:

linkInfo - The link information.

Returns:

Generated link.

Throws:

AssetAccessException - an AssetAccessException.

makeBlobLink

public String makeBlobLink(BlobLinkInfo linkInfo)
                    throws AssetAccessException

Description copied from interface: AssetFacade

Generate a blob link given table, identifierColumnName, identifier, and columnname with given BlobLinkInfo

Specified by:

makeBlobLink in interface AssetFacade

Parameters:

linkInfo - The blob link information.

Returns:

The generated blob link.

Throws:

AssetAccessException - an AssetAccessException

getSegments

public List<AssetId> getSegments(String alias,
                                 String profileName,
                                 Map<String,Object> profile,
                                 String sitename)

Description copied from interface: AssetFacade

Get the segments that the visitor belongs to with visitor alias and visitor attributes.

Specified by:

getSegments in interface AssetFacade

Parameters:

alias - The visitor alias.

profileName - The name of the visitor profile.

profile - The visitor's profile (which is a map containing the attributes).

sitename - The site name.

Returns:

The list of segments that the visitor belongs to.

retainSegments

public List<AssetId> retainSegments(String alias,
                                    String profileName,
                                    Map<String,Object> profile,
                                    String segments,
                                    String sitename)

Description copied from interface: AssetFacade

Get the segments from the specified list that the visitor belongs to with visitor alias and visitor attributes

Specified by:

retainSegments in interface AssetFacade

Parameters:

alias - The visitor alias

profileName - The name of the visitor profile.

profile - The visitor's profile (which is a map containing the attributes).

segments - The list of segment names separated by ",".

sitename - The site name.

Returns:

The list of segments that the visitor belongs to.

getRecommendations

public List<RecommendedAssetId> getRecommendations(String recommendationName,
                                                   String visitorId,
                                                   String profileName,
                                                   Map<String,Object> profile,
                                                   String segments,
                                                   String sitename,
                                                   boolean keepSegments)
                                            throws AssetAccessException

Description copied from interface: AssetFacade

Get a list of recommended assets.

Specified by:

getRecommendations in interface AssetFacade

Parameters:

recommendationName - the recommendation asset name to retrieve assets from.

visitorId - The visitor alias.

profileName - The name of the visitor profile.

profile - The visitor's profile (which is a map containing the attributes).

segments - The list of segment names separated by "," if known.

sitename - The site name.

Returns:

The list of recommended assets from the recommendation.

Throws:

AssetAccessException - an AssetAccessException

populateScalarDataFromProfile

protected void populateScalarDataFromProfile(com.openmarket.gator.interfaces.IVisitorDataManager vdm,
                                             String profileName,
                                             Map<String,Object> profileData,
                                             Long siteId,
                                             Map<String,String> scalarAttributesSet)
                                      throws com.openmarket.basic.interfaces.AssetException,
                                             NoSuchFieldException

Populates ScalarVars data from the given profile. This (optionally) interacts with the Site Visitor Service (SVS) to obtain profile information.

Parameters:

vdm - an IVisitorDataManager

profileName - a String

profileData - a Map

siteId - a Long

scalarAttributesSet - a Map

Throws:

NoSuchFieldException - a NoSuchFieldException

com.openmarket.basic.interfaces.AssetException

getExpressionForProfileName

protected String getExpressionForProfileName(String valueSource,
                                             String profileName)

Returns the appropriate expression for the given profileName from the valueSource field of the visitor attribute. For example, a typical valueSource defined for a ScalarVals would be something like: PROF1.user.info.age,PROF2.userData[2].customer.age If the caller requests the "PROF2" profile expression, then this method will return: PROF2.userData[2].customer.age

Parameters:

valueSource - The valuesource field value defined in the VMSCALARATTRIBUTEDEF table.

profileName - The profile name whose expression should be retrieved.

Returns:

the jexl expression for the given profile, or null otherwise.

evaluateProfileExpression

protected Object evaluateProfileExpression(String profileName,
                                           Map<String,Object> profileValues,
                                           String pattern)

Evaluate the profile expression value against the profile data, returning the profile value.

Parameters:

profileName - The name of the profile, perhaps "PROF2"

profileValues - The profile map of values

pattern - The pattern expression to extract, perhaps PROF2.userData[2].customer.age

Returns:

The value for the expression, obtained from the profile data, otherwise null.

restoreVisitorAttributes

protected void restoreVisitorAttributes(com.openmarket.gator.interfaces.IVisitorDataManager vdm,
                                        Map<String,String> scalarAttributesSet)

isAttributeExist

public boolean isAttributeExist(AssetData assetData,
                                String attribute)

Description copied from interface: AssetFacade

Check if an Attribute exist in current assetData.

Specified by:

isAttributeExist in interface AssetFacade

Parameters:

assetData - The AssetData.

attribute - The attribute name to check.

Returns:

True if the attribute exists in AssetData, else false.

filterSingleAsset

public AssetId filterSingleAsset(AssetId asset,
                                 String desiredLocale,
                                 String dimensionSetName)
                          throws com.fatwire.mda.DimensionException

Description copied from interface: AssetFacade

Filter an asset based on a DimensionSet and a preferred locale.

Specified by:

filterSingleAsset in interface AssetFacade

Parameters:

asset - The asset to filter.

desiredLocale - The preferred locale.

dimensionSetName - name of the DimensionSet to be used.

Returns:

The filtered asset.

Throws:

com.fatwire.mda.DimensionException - an DimensionException

getRelatives

public Collection<AssetId> getRelatives(AssetId assetId)

Description copied from interface: AssetFacade

Retrieve the relatives of a given asset in a Collection.

Specified by:

getRelatives in interface AssetFacade

Parameters:

assetId - The asset id of interested asset.

Returns:

Collection of relative asset ids.

getImmediateChildren

public List<AssetId> getImmediateChildren(String siteName,
                                          AssetId assetId)

Description copied from interface: AssetFacade

Get the immediate children of a given flex parent asset.

Specified by:

getImmediateChildren in interface AssetFacade

Parameters:

siteName - The site name of the site children are interested in.

assetId - The asset id.

Returns:

The list of immediate flex children of the given flex parent.

getAssetByName

public AssetId getAssetByName(String siteName,
                              String assetType,
                              String assetName)

Description copied from interface: AssetFacade

Retrieve an asset id from an asset name; for the possible multiple returns (assets with same names), we will return the first asset from the list.

Specified by:

getAssetByName in interface AssetFacade

Parameters:

siteName - The site name.

assetType - The asset type.

assetName - The asset name.

Returns:

The first AssetId returned.

processEmbeddedLink

public String processEmbeddedLink(String data)

Description copied from interface: AssetFacade

Process the embeddedLink inside a String/Text attribute and return the processed result.

Specified by:

processEmbeddedLink in interface AssetFacade

Parameters:

data - The attribute value that needs to be processed.

Returns:

The processed data.

processEmbeddedLink

public String processEmbeddedLink(InputStream data)

Description copied from interface: AssetFacade

Process the embeddedLink inside a binary attribute and return the processed result.

Specified by:

processEmbeddedLink in interface AssetFacade

Parameters:

data - The attribute value that needs to be processed.

Returns:

The processed data.

executeContentQuery

public List<AssetResultRow> executeContentQuery(String siteName,
                                                Long assetId,
                                                String assetName,
                                                int limit,
                                                String sortingField,
                                                boolean ascending)
                                         throws AssetAccessException

Description copied from interface: AssetFacade

Execute a ContentQuery to retrieve the results.

Specified by:

executeContentQuery in interface AssetFacade

Parameters:

siteName - The site name.

assetId - The ContentQuery ID.

assetName - The ContentQuery name, one of the id or name needs to present for this method to work.

limit - The limit of how many assets will be returned.

sortingField - The sorting field to sort the results.

ascending - whether sort in ascending or descending order.

Returns:

The list of AssetResultRow returned by the ContentQuery.

Throws:

AssetAccessException

getPublicationId

public Long getPublicationId(String assetName)

Description copied from interface: AssetFacade

Get the publication id given a publication name.

Specified by:

getPublicationId in interface AssetFacade

Parameters:

assetName - The publication name.

Returns:

The publication id returned for that name.

isAssetInSite

public boolean isAssetInSite(AssetId asset,
                             String site)

Specified by:

isAssetInSite in interface AssetFacade

recordBlobDependency

public void recordBlobDependency(String blobkey,
                                 String depns)

Specified by:

recordBlobDependency in interface AssetFacade