com.fatwire.assetapi.data

Interface AssetReader

@Exported
public interface AssetReader

A reader that allows user to read asset information in a simplified way AssetReader provides the ability for a user to retrieve an Asset information in a unified way for all asset types. The reader allows user retrieving asset information by specifying an AssetId or an AssetType/name pair. It further allows user to retrieve nested asset information using grammar or another AssetReader The results returned from AssetReader.read() method is a Map, which contains the requested asset information in a Map format. Sample code snippet:

     Map data = new AssetReaderImpl(new AssetFacadeImpl(ics))
          .forAsset( assetId )
          .select( "name, description, AssociatedAssetOne.(name, description, body)" )
          .levelOfChildren(2)
          .selectImmediateOnlyParents(true)
          .useAssetReader( "Content_P", null, new AssetReaderImpl(new AssetFacadeImpl(ics)).selectAll(true) )
          .includeLinks(true)
          .includeBlobLinks(true)
          .includeFeatures(true)
          .forLocale("en_US")
          .read();
           

Method Summary

Modifier and Type	Method and Description
AssetReader	addAssetLinkInfo(LinkInfo linkInfo) Adds a LinkInfo object for building a link for the read asset
AssetReader	addAssetLinkInfos(List<LinkInfo> linkInfos) Adds a list of LinkInfo objects for building a link for the read asset
AssetReader	addBlobLinkInfo(BlobLinkInfo blobLinkMaker) Adds a default BlobLinkInfo object for building blob links contained in the asset for all fields without a specific BlobLinkInfo object specified.
AssetReader	addBlobLinkInfo(String field, BlobLinkInfo blobLinkMaker) Adds a BlobLinkInfo object for building blob links contained in the asset for given field
AssetReader	filterForDate(Date date) Filter the assets by date; This is used together with the startdate and enddate in the asset.
AssetReader	forAsset(AssetId assetId) Specify the asset by an AssetId
AssetReader	forAsset(String assettype, Long assetid) Specify the asset type, id of the interested asset
AssetReader	forAssetName(String assetType, String assetName) Specify the asset by name; There is always chance that several assets with same name exists in Sites.
AssetReader	forLocale(String locale) Specify interested Locale for the asset.
AssetReader	forLocale(String locale, String dimensionSet) Specify interested Locale for the asset and a DimensionSet filter to obtain asset translation.
AssetReader	forSite(String siteName) Specify the sitename the AssetReader is working upon.
AssetReader	immediateOnlyAttributes(boolean immediateOnlyAttributes) Specifies whether or not to retrieve immediate-only attributes for flex assets/parents.
AssetReader	includeFeatures(boolean includeFeatures) Specify whether to include the Asset features like AssetType, subtype, dimensions and such in the asset map.
AssetReader	includeLinks(boolean includeLink) indicate whether to include a Link in the returned Object; when set yes, the AssetReader will retrieve the Webreference (Vanity Urls) defined in the asset and return the first one in the list as _link_ in the returned Object.
AssetReader	includeLinksForBlobs(boolean includeBlobLinks) indicate whether to include a Link in the returned Object; when set yes, the AssetReader will retrieve the Webreference (Vanity Urls) defined in the Blob and return the first one in the list as [BlobAttributeName]_link_ in the returned Object.
AssetReader	levelOfChildren(int level) Specify the level of flex children to bring back in the children list if the asset is an flex parent
Map	read() Read the asset bean with information specified.
AssetReader	select(String attributes) Specify a list of attributes to retrieve
AssetReader	selectAll(boolean all) Indicates whether all the attributes are needed.
AssetReader	selectImmediateOnlyParents(boolean immediateOnly) Indicates whether parents will be selected and what attributes will be selected.
AssetReader	selectParents(String parentDefName) Indicates to select a parent of certain definition.
AssetReader	useAssetReader(String assettype, String subtype, AssetReader assetReader) Specify an AssetReader to use for flex children, flex parent of specified assettype and subtype.
AssetReader	useWrapper(String wrapper) If the target uses an uncached wrapper page, supply this argument with the name of that SiteCatalog page.

Method Detail

forAsset

AssetReader forAsset(String assettype,
                     Long assetid)

Specify the asset type, id of the interested asset

Parameters:

assettype - the asset type

assetid - the asset id

Returns:

an AssetReader instance with type/id specified

forAsset

AssetReader forAsset(AssetId assetId)

Specify the asset by an AssetId

Parameters:

assetId - the asset id

Returns:

an AssetReader instance with asset id specified

forAssetName

AssetReader forAssetName(String assetType,
                         String assetName)

Specify the asset by name; There is always chance that several assets with same name exists in Sites. In that case, we will pick the first returned asset sorted by id

Parameters:

assetType - the asset type

assetName - the asset name

Returns:

the AssetReader

levelOfChildren

AssetReader levelOfChildren(int level)

Specify the level of flex children to bring back in the children list if the asset is an flex parent

Parameters:

level - int number of children to bring back

Returns:

an AssetReader

useAssetReader

AssetReader useAssetReader(String assettype,
                           String subtype,
                           AssetReader assetReader)

Specify an AssetReader to use for flex children, flex parent of specified assettype and subtype.

Parameters:

assettype - the asset type

subtype - the asset subtype

assetReader - the assetReader

Returns:

an AssetReader

forSite

AssetReader forSite(String siteName)

Specify the sitename the AssetReader is working upon.

Parameters:

siteName - the String sitename

Returns:

an AssetReader

select

AssetReader select(String attributes)

Specify a list of attributes to retrieve

Parameters:

attributes - list of asset attributes

Returns:

an AssetReader instance with attributes specified

forLocale

AssetReader forLocale(String locale)

Specify interested Locale for the asset. Note, this method resets the locale, (if any) previously set by forLocale(locale, dimensionSet).

Parameters:

locale - The name of the Locale, which is the Dimension asset name you defined for Locale DimensionSet.

Returns:

an AssetReader

forLocale

AssetReader forLocale(String locale,
                      String dimensionSet)

Specify interested Locale for the asset and a DimensionSet filter to obtain asset translation. Note, this method resets the locale, (if any) previously set by forLocale(locale). If dimensionSet is null the call is same as forLocale(locale)

Parameters:

locale - the name of the Locale, which is the Dimension asset name you defined for Locale DimensionSet

dimensionSet - name of the DimensionSet to be used

Returns:

an AssetReader

filterForDate

AssetReader filterForDate(Date date)

Filter the assets by date; This is used together with the startdate and enddate in the asset. If the page is rendered before the asset's start date, then the page's cache expiry date is set to the asset's start date. If the page is rendered after the asset's start date but before asset's end date, then the page's cache expiry date is set to the asset's end date. If the page is rendered after the asset's end date, then the page's cache expiry date is set to normal.

Parameters:

date - the date on which the asset is interested in; null means filter is not needed

Returns:

an Assetbuilder

selectAll

AssetReader selectAll(boolean all)

Indicates whether all the attributes are needed.

Parameters:

all - true indicate all attributes will be retrieved; false otherwise

Returns:

an AssetReader

addAssetLinkInfo

AssetReader addAssetLinkInfo(LinkInfo linkInfo)

Adds a LinkInfo object for building a link for the read asset

Parameters:

linkInfo - a LinkInfo

Returns:

an AssetReader

addAssetLinkInfos

AssetReader addAssetLinkInfos(List<LinkInfo> linkInfos)

Adds a list of LinkInfo objects for building a link for the read asset

Parameters:

linkInfos - LinkInfo

Returns:

an AssetReader

addBlobLinkInfo

AssetReader addBlobLinkInfo(String field,
                            BlobLinkInfo blobLinkMaker)

Adds a BlobLinkInfo object for building blob links contained in the asset for given field

Parameters:

field - the field to use this BlobLinkInfo

blobLinkMaker - a BlobLinkInfo

Returns:

an AssetReader

addBlobLinkInfo

AssetReader addBlobLinkInfo(BlobLinkInfo blobLinkMaker)

Adds a default BlobLinkInfo object for building blob links contained in the asset for all fields without a specific BlobLinkInfo object specified.

Parameters:

blobLinkMaker - a BlobLinkInfo

Returns:

an AssetReader

includeLinks

AssetReader includeLinks(boolean includeLink)

indicate whether to include a Link in the returned Object; when set yes, the AssetReader will retrieve the Webreference (Vanity Urls) defined in the asset and return the first one in the list as _link_ in the returned Object.

Parameters:

includeLink - boolean to indicate whether to include the default link from Webreference; default is false

Returns:

the AssetReader

includeLinksForBlobs

AssetReader includeLinksForBlobs(boolean includeBlobLinks)

indicate whether to include a Link in the returned Object; when set yes, the AssetReader will retrieve the Webreference (Vanity Urls) defined in the Blob and return the first one in the list as [BlobAttributeName]_link_ in the returned Object.

Parameters:

includeBlobLinks - boolean to indicate whether to include the default links from Webreference for the Blob attributes; default is false

Returns:

the AssetReader

selectImmediateOnlyParents

AssetReader selectImmediateOnlyParents(boolean immediateOnly)

Indicates whether parents will be selected and what attributes will be selected.

Parameters:

immediateOnly - Indicates whether to select immediate parents only or all the parents.

Returns:

an AssetReader

selectParents

AssetReader selectParents(String parentDefName)

Indicates to select a parent of certain definition.

Parameters:

parentDefName - The parent definition name to select.

Returns:

an AssetReader

includeFeatures

AssetReader includeFeatures(boolean includeFeatures)

Specify whether to include the Asset features like AssetType, subtype, dimensions and such in the asset map.

Parameters:

includeFeatures - True indicates that features will be included in asset map, false otherwise.

Returns:

an AssetReader

immediateOnlyAttributes

AssetReader immediateOnlyAttributes(boolean immediateOnlyAttributes)

Specifies whether or not to retrieve immediate-only attributes for flex assets/parents.

Parameters:

immediateOnlyAttributes - True indicate only immediate attributes will be retrieved, false otherwise.

Returns:

an AssetReader

useWrapper

AssetReader useWrapper(String wrapper)

If the target uses an uncached wrapper page, supply this argument with the name of that SiteCatalog page.

Parameters:

wrapper - The wrapper page name.

Returns:

a AssetReader

read

Map read()
  throws AssetAccessException

Read the asset bean with information specified. The map contains name-value pairs of the requested asset information. The returned Map would contain the information about the map is the same format that specified by "attributes" statement in select(String attributes) method. If specified, it would also contain a map named features, which contains entries for assettype, subtype, hasTranslation, isTimeBound, and isExpired in it.

Returns:

a Map as a bean for the asset

Throws:

AssetAccessException - an AssetAccessException