AssetDataManagerImpl (Oracle WebCenter Sites Java API Reference)

java.lang.Object
- com.fatwire.assetapi.data.AssetDataManagerImpl

All Implemented Interfaces:

AssetDataManager
```
@Exported
public class AssetDataManagerImpl
extends Object
implements AssetDataManager
```
AssetDataManager implementation class The class has two variant of read methods: 1. Read with a set of attribute names to retrieve specified - in this case, attribute names are specified either directly in the method signature, for example readAttributes (AssetId id, List<String> attributeNames) or in the query read(Query query). We consider the user is intending to read only the attribute specified (immediate only) and do not want to retrieve the inherited data from parent. 2. Read with only id specified but no attribute names - in this case, we assume that user wants all the attributes with inherited values. AssetDataManagerImpl is the entry point for retrieving Content Server asset data and it defaults the actual operation of reading the data to the specific strategies for each different asset types. Each asset read strategy is an implementation of AssetDataReadStrategy interface and deal with a special type of asset. At the heart of all the read strategies is BasicAssetDataReadStrategy, which reads all the basic asset types including some system asset types like Page, Collection, Query, Link, DimensionSet, and Dimension, sample asset types including Article, Linkset , and Image, Asset Maker asset types, Flex Attributes, Flex Parent definitions, Flex Definitions, Flex Filters, and the basic values of other asset types. On top of BasicAssetReadStrategy, we have FlexAssetDataReadStrategy and several other asset data read strategies to read other special asset types like Template, CSElement, AdvCols(Recommendation), Promotions, HField, HistoryVals, ScalarVals.

Constructor Summary

Constructors
Constructor and Description

AssetDataManagerImpl(ICS ics)

Constructors
Constructor and Description
`AssetDataManagerImpl(ICS ics)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MutableAssetData`	`deepCopy(AssetData example)` Creates a deep copy of an AssetData object, copying all the data.
`void`	`delete(List<AssetId> data)` Deletes a given list of AssetIds from database.
`static AssetReader`	`getAssetBuilder(ICS ics)`
`void`	`insert(List<AssetData> data)` Inserts a given List of AssetData instances in the database and new assets will be created with the data from the list.
`AssetData`	`newAssetData(String assetTypeName, AssetData example)` Creates an instance of AssetData (with copied instances of AttributeData from the example AssetData).
`MutableAssetData`	`newAssetData(String assetTypeName, String subtype)` Create an empty instance of AssetData with empty instance of AttributeData.
`AttributeData`	`newAttribiteData(String attributeName, String assetTypeName, String subtype)` Creates an empty instance of AttributeData (of appropriate type and default).
`AttributeData`	`newAttributeData(AttributeDef attributeDef)` Create an attributeData with an attribute definition specified.
`AttributeData`	`newAttributeData(String attributeName, String assetTypeName, String subtype)` Creates an empty instance of AttributeData (of appropriate type and default).
`Iterable<AssetData>`	`read(List<AssetId> ids)` Reads asset data for all given `AssetId`s.
`Iterable<AssetData>`	`read(Query query)` Read a list of Asset Data that satisfy the query.
`AssetData`	`readAttributes(AssetId id, List<String> attributeNames)` Reads given set attribute data and returns an AssetData instance containing them.
`Iterable<MutableAssetData>`	`readForUpdate(List<AssetId> ids)` Read a list of asset data to update.
`Iterable<MutableAssetData>`	`readForUpdate(Query query)` Reads all asset data that satisfies a given Query and results in mutable results.
`void`	`update(List<AssetData> data)` Updates a given list of AssetData in the database.
`void`	`update(List<AssetData> data, boolean keepCheckedOut)` Updates a given list of AssetData in the database.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AssetDataManagerImpl
```
public AssetDataManagerImpl(ICS ics)
```
- Method Detail
  - getAssetBuilder
```
public static AssetReader getAssetBuilder(ICS ics)
```
  - read
```
public Iterable<AssetData> read(Query query)
                         throws AssetAccessException
```
    Read a list of Asset Data that satisfy the query. The query against flex assets is considered only to immediately retrieve attributes. It will not retrieve the parent inherited attributes.
    
    Specified by:
    
    read in interface AssetDataManager
    
    Parameters:
    
    query - the Query object
    
    Returns:
    
    Iterable of asset data.
    
    Throws:
    
    AssetAccessException - an AssetAccessException.
  - readForUpdate
```
public Iterable<MutableAssetData> readForUpdate(Query query)
                                         throws AssetAccessException
```
    Description copied from interface: AssetDataManager
    
    Reads all asset data that satisfies a given Query and results in mutable results.
    
    Specified by:
    
    readForUpdate in interface AssetDataManager
    
    Parameters:
    
    query - Query to be satisfied.
    
    Returns:
    
    Iterator of MutableAssetData instances.
    
    Throws:
    
    AssetAccessException - is the layer specific failures and wraps other internal exceptions.
  - read
```
public Iterable<AssetData> read(List<AssetId> ids)
                         throws AssetAccessException,
                                AssetNotExistException
```
    Description copied from interface: AssetDataManager
    
    Reads asset data for all given AssetIds.
    
    Specified by:
    
    read in interface AssetDataManager
    
    Parameters:
    
    ids - the list of asset ids to read.
    
    Returns:
    
    Iterable of asset data.
    
    Throws:
    
    AssetAccessException - rethrown exception.
    
    AssetNotExistException - an AssetNotExistException
  - readForUpdate
```
public Iterable<MutableAssetData> readForUpdate(List<AssetId> ids)
                                         throws AssetAccessException,
                                                AssetNotExistException
```
    Read a list of asset data to update.
    
    Specified by:
    
    readForUpdate in interface AssetDataManager
    
    Parameters:
    
    ids - The list of asset IDs to read.
    
    Returns:
    
    Iterable of asset data.
    
    Throws:
    
    AssetAccessException - an AssetAccessException.
    
    AssetNotExistException - an AssetNotExistException
  - readAttributes
```
public AssetData readAttributes(AssetId id,
                                List<String> attributeNames)
                         throws AssetAccessException,
                                AssetNotExistException
```
    Description copied from interface: AssetDataManager
    
    Reads given set attribute data and returns an AssetData instance containing them.
    
    Specified by:
    
    readAttributes in interface AssetDataManager
    
    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
  - insert
```
public void insert(List<AssetData> data)
            throws AssetAccessException
```
    Description copied from interface: AssetDataManager
    
    Inserts a given List of AssetData instances in the database and new assets will be created with the data from the list. After the operation complete, the passed in AssetData in the list will be populated with the newly created Asset id.
    
    Specified by:
    
    insert in interface AssetDataManager
    
    Parameters:
    
    data - AssetData to be inserted.
    
    Throws:
    
    AssetAccessException - Captures layer specific failures and wraps other internal exceptions.
  - update
```
public void update(List<AssetData> data)
            throws AssetAccessException
```
    Description copied from interface: AssetDataManager
    
    Updates a given list of AssetData in the database. Content Server will use the AssetId in AssetData objects to determine which Asset in Content Server to update. An AssetAccessException will be thrown if the AssetData passed in does not exist in Content Server.
    
    Specified by:
    
    update in interface AssetDataManager
    
    Parameters:
    
    data - AssetData to be updated.
    
    Throws:
    
    AssetAccessException - Captures layer specific failures and wraps other internal exceptions.
  - update
```
public void update(List<AssetData> data,
                   boolean keepCheckedOut)
            throws AssetAccessException
```
    Description copied from interface: AssetDataManager
    
    Updates a given list of AssetData in the database. Content Server will use the AssetId in AssetData objects to determine which Asset in Content Server to update. An AssetAccessException will be thrown if the AssetData passed in does not exist in Content Server.
    
    Specified by:
    
    update in interface AssetDataManager
    
    Parameters:
    
    data - AssetData to be updated.
    
    keepCheckedOut - Do not check in asset after save if revision tracked.
    
    Throws:
    
    AssetAccessException - Captures layer specific failures and wraps other internal exceptions.
  - delete
```
public void delete(List<AssetId> data)
            throws AssetAccessException
```
    Description copied from interface: AssetDataManager
    
    Deletes a given list of AssetIds from database. No assets will be deleted if one of them is being referenced.
    
    Specified by:
    
    delete in interface AssetDataManager
    
    Parameters:
    
    data - AssetIds to be deleted.
    
    Throws:
    
    AssetAccessException - Captures layer specific failures and wraps other internal exceptions.
  - newAttribiteData
```
public AttributeData newAttribiteData(String attributeName,
                                      String assetTypeName,
                                      String subtype)
```
    Description copied from interface: AssetDataManager
    
    Creates an empty instance of AttributeData (of appropriate type and default).
    
    Specified by:
    
    newAttribiteData in interface AssetDataManager
    
    Parameters:
    
    attributeName - Name of the attribute.
    
    assetTypeName - Name of asset type.
    
    subtype - Subtype of asset type.
    
    Returns:
    
    Empty AttributeData for a given attribute name and attribute type.
  - newAttributeData
```
public AttributeData newAttributeData(String attributeName,
                                      String assetTypeName,
                                      String subtype)
```
    Description copied from interface: AssetDataManager
    
    Creates an empty instance of AttributeData (of appropriate type and default).
    
    Specified by:
    
    newAttributeData in interface AssetDataManager
    
    Parameters:
    
    attributeName - Name of the attribute.
    
    assetTypeName - Name of asset type.
    
    subtype - Subtype of asset type.
    
    Returns:
    
    Empty AttributeData for a given attribute name and attribute type.
  - newAttributeData
```
public AttributeData newAttributeData(AttributeDef attributeDef)
```
    Description copied from interface: AssetDataManager
    
    Create an attributeData with an attribute definition specified.
    
    Specified by:
    
    newAttributeData in interface AssetDataManager
    
    Parameters:
    
    attributeDef - The definition of the attribute.
    
    Returns:
    
    The attribute data with empty value.
  - newAssetData
```
public MutableAssetData newAssetData(String assetTypeName,
                                     String subtype)
                              throws AssetAccessException
```
    Description copied from interface: AssetDataManager
    
    Create an empty instance of AssetData with empty instance of AttributeData.
    
    Specified by:
    
    newAssetData in interface AssetDataManager
    
    Parameters:
    
    assetTypeName - The name of the asset type.
    
    subtype - The name of the asset subtype.
    
    Returns:
    
    Empty instance of AssetData.
    
    Throws:
    
    AssetAccessException - an AssetAccessException
  - newAssetData
```
public AssetData newAssetData(String assetTypeName,
                              AssetData example)
```
    Description copied from interface: AssetDataManager
    
    Creates an instance of AssetData (with copied instances of AttributeData from the example AssetData).
    
    Specified by:
    
    newAssetData in interface AssetDataManager
    
    Parameters:
    
    assetTypeName - Name of the asset type
    
    example - Optional example AssetData the returned will be based on.
    
    Returns:
    
    an instance of AssetData
  - deepCopy
```
public MutableAssetData deepCopy(AssetData example)
                          throws AssetAccessException
```
    Creates a deep copy of an AssetData object, copying all the data.
    
    Parameters:
    
    example - The asset data where to copy the data from.
    
    Returns:
    
    The deep copy of the asset data.
    
    Throws:
    
    AssetAccessException - Throws exception if error met creating the copy.

Class AssetDataManagerImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AssetDataManagerImpl

Method Detail

getAssetBuilder

read

readForUpdate

read

readForUpdate

readAttributes

insert

update

update

delete

newAttribiteData

newAttributeData

newAttributeData

newAssetData

newAssetData

deepCopy