com.fatwire.assetapi.data

Class CSElementReadStrategy

java.lang.Object

com.fatwire.assetapi.data.BasicAssetDataReadStrategy

com.fatwire.assetapi.data.CSElementReadStrategy

All Implemented Interfaces:

AssetDataReadStrategy

public final class CSElementReadStrategy
extends BasicAssetDataReadStrategy
implements AssetDataReadStrategy

Read a Content Server CSElement

Field Summary

Fields

Modifier and Type	Field and Description
protected AssetTypeDef	_def
static List<String>	allCSElementStandardAttributes
static List<String>	elementStandardAttributes
protected List<String>	specialAttributes

Fields inherited from class com.fatwire.assetapi.data.BasicAssetDataReadStrategy

basicStandAttributes

Constructor Summary

Constructors

Constructor and Description
CSElementReadStrategy(ICS ics)

Method Summary

Modifier and Type	Method and Description
protected static void	_checkElementCatalogPrivileges(ICS ics)
protected static void	_checkSiteCatalogPrivileges(ICS ics)
protected boolean	allStandardAttributes(List<String> attributeNames)
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.
protected void	retrieveSpecialAttributes(MutableAssetData data, com.openmarket.xcelerate.interfaces.IAsset asset, List<String> attributeNames) Each special assets that is not flex assets would most go through the Basic Asset Strategy and then calls its own retrieving special attribute to handles the specially available attributes for themselves

Methods inherited from class com.fatwire.assetapi.data.BasicAssetDataReadStrategy

getAssetDefinitionType, performQuery

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.fatwire.assetapi.data.AssetDataReadStrategy

read, read, read, readAttributes

Field Detail

elementStandardAttributes

public static List<String> elementStandardAttributes

allCSElementStandardAttributes

public static List<String> allCSElementStandardAttributes

specialAttributes

protected List<String> specialAttributes

_def

protected AssetTypeDef _def

Constructor Detail

CSElementReadStrategy

public CSElementReadStrategy(ICS ics)

Method Detail

allStandardAttributes

protected boolean allStandardAttributes(List<String> attributeNames)

Overrides:

allStandardAttributes in class BasicAssetDataReadStrategy

retrieveSpecialAttributes

protected void retrieveSpecialAttributes(MutableAssetData data,
                                         com.openmarket.xcelerate.interfaces.IAsset asset,
                                         List<String> attributeNames)
                                  throws AssetAccessException

Each special assets that is not flex assets would most go through the Basic Asset Strategy and then calls its own retrieving special attribute to handles the specially available attributes for themselves

Parameters:

data - the half constructed AssetData

asset - the IAsset object

attributeNames - the names of the attributes that user requested, null indicates all are requested.

Throws:

AssetAccessException - an AssetAccessException

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

Overrides:

read in class BasicAssetDataReadStrategy

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 AssetExcptions 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

Overrides:

read in class BasicAssetDataReadStrategy

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

Overrides:

read in class BasicAssetDataReadStrategy

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 AssetExcptions thrown by the internal implementation.

AssetNotExistException - an AssetNotExistException

readAttributes

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

Description copied from interface: AssetDataReadStrategy

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

Specified by:

readAttributes in interface AssetDataReadStrategy

Overrides:

readAttributes in class BasicAssetDataReadStrategy

Parameters:

id - AssetId to read attributes for

attributeNames - names of the attributes

Returns:

AssetData containing values for requested attributes.

Throws:

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

AssetNotExistException - an AssetNotExistException

_checkSiteCatalogPrivileges

protected static void _checkSiteCatalogPrivileges(ICS ics)
                                           throws AssetAccessException

Throws:

AssetAccessException

_checkElementCatalogPrivileges

protected static void _checkElementCatalogPrivileges(ICS ics)
                                              throws AssetAccessException

Throws:

AssetAccessException