com.fatwire.assetapi.data

Class BasicAssetDataReadStrategy

java.lang.Object

com.fatwire.assetapi.data.BasicAssetDataReadStrategy

All Implemented Interfaces:

AssetDataReadStrategy

Direct Known Subclasses:

ControllerAssetReadStrategy, CSElementReadStrategy, DimensionSetReadStrategy, FlexAttributeReadStrategy, FlexDefReadStrategy, FlexFilterReadStrategy, FlexPDReadStrategy, HistoryGroupReadStrategy, PageDefinitionReadStrategy, ProxyReadStrategy, RecommendationReadStrategy, RevisionAssetDataReadStrategy, SegmentReadStrategy, SegmentsReadStrategy, SiteNavigationAssetReadStrategy

@Exported
public class BasicAssetDataReadStrategy
extends Object
implements AssetDataReadStrategy

BasicAssetDataReadStrategy is basic class that read Content Server asset data. It reads the asset data for the following asset types: Page, Collection, Link, Query, DimensionSet, Dimension, Article, Linkset, Image; it also read asset data for all the Asset Maker asset types, Flex Attribute types, Flex Filter Types, Flex (parent) Definition types, and other asset types that do not have a specific reader. Not only the BasicAssetDataReadStrategy reads these asset types, it also reads the basic attribute values for Flex Assets, Flex Parent assets and other special asset types. If no specific strategy is specified for an asset type, BasicAssetDataReadStrategy is going to be used.

Field Summary

Fields

Modifier and Type	Field and Description
static List<String>	basicStandAttributes

Constructor Summary

Constructors

Constructor and Description
BasicAssetDataReadStrategy(ICS ics)

Method Summary

Modifier and Type	Method and Description
protected boolean	allStandardAttributes(List<String> attributeNames)
protected String	getAssetDefinitionType(ICS ics, com.openmarket.xcelerate.asset.AssetType type, String attributename)
protected String	performQuery(Query query, String assettype, String subtype, AssetTypeDef def, boolean isFlex, List<String> uniqIds)
MutableAssetData	read(com.openmarket.xcelerate.interfaces.IAsset asset, AssetId id) Reads asset data for the given AssetId from the AssetId specified.
Iterable<MutableAssetData>	read(List<AssetId> ids) Reads asset data for all given AssetIds.
Iterable<MutableAssetData>	read(Query query) Reads all asset data that satisfies a given Query.
MutableAssetData	readAttributes(AssetId id, List<String> attributeNames) Reads given set attribute data and returns an AssetData instance containing them.

Methods inherited from class java.lang.Object

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

Field Detail

basicStandAttributes

public static List<String> basicStandAttributes

Constructor Detail

BasicAssetDataReadStrategy

public BasicAssetDataReadStrategy(ICS ics)

Method Detail

read

public Iterable<MutableAssetData> read(Query query)
                                throws AssetAccessException

Description copied from interface: AssetDataReadStrategy

Reads all asset data that satisfies a given Query.

Specified by:

read in interface AssetDataReadStrategy

Parameters:

query - Query to be satisfied.

Returns:

Iterator of AssetData instances.

Throws:

AssetAccessException - Is thrown when Query is invalid by the way of incorrect attributes or invalid operation given the choice of query algorithm. AssetAccessException also wraps any AssetExceptions thrown by the internal implementation.

read

public MutableAssetData read(com.openmarket.xcelerate.interfaces.IAsset asset,
                             AssetId id)
                      throws AssetAccessException

Description copied from interface: AssetDataReadStrategy

Reads asset data for the given AssetId from the AssetId specified.

Specified by:

read in interface AssetDataReadStrategy

Parameters:

asset - The asset where the asset will be read from.

id - AssetId to read for.

Returns:

a MutableAssetData

Throws:

AssetAccessException - Is thrown when error met reading the data from the asset.

read

public Iterable<MutableAssetData> read(List<AssetId> ids)
                                throws AssetAccessException,
                                       AssetNotExistException

Description copied from interface: AssetDataReadStrategy

Reads asset data for all given AssetIds.

Specified by:

read in interface AssetDataReadStrategy

Parameters:

ids - List of AssetIds.

Returns:

Iterator of AssetData instances belonging to AssetIds.

Throws:

AssetAccessException - Is thrown when any of the AssetIds passed in does not exist. AssetAccessException also wraps any AssetExceptions thrown by the internal implementation.

AssetNotExistException - an AssetNotExistException

readAttributes

public MutableAssetData readAttributes(AssetId id,
                                       List<String> attributeNames)
                                throws AssetAccessException,
                                       AssetNotExistException

Description copied from interface: AssetDataReadStrategy

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

Specified by:

readAttributes in interface AssetDataReadStrategy

Parameters:

id - AssetId to read attributes for.

attributeNames - 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.

AssetNotExistException - an AssetNotExistException.

getAssetDefinitionType

protected String getAssetDefinitionType(ICS ics,
                                        com.openmarket.xcelerate.asset.AssetType type,
                                        String attributename)
                                 throws com.openmarket.basic.interfaces.AssetException

Throws:

com.openmarket.basic.interfaces.AssetException

performQuery

protected String performQuery(Query query,
                              String assettype,
                              String subtype,
                              AssetTypeDef def,
                              boolean isFlex,
                              List<String> uniqIds)
                       throws AssetAccessException

Throws:

AssetAccessException

allStandardAttributes

protected boolean allStandardAttributes(List<String> attributeNames)