com.fatwire.assetapi.query

Interface AssetStatisticsSearcher

All Known Implementing Classes:

AssetStatisticsSearcherImpl

@Exported
public interface AssetStatisticsSearcher

The searcher interface that search for asset statistics actions in Site. The assets statistics not only includes basic statistics such as the number of assets in a site, the number of assets include in a past publishing, the list of assets that are checked out; it also includes asset history actions such as when an asset is created/edited by whom, when the asset was put into workflow and things like that. This is an internal facing interface.

Field Summary

Fields

Modifier and Type	Field and Description
static String	HELD
static String	PUBLISHABLE

Method Summary

Modifier and Type	Method and Description
int	assetsCount(String siteName, boolean contentAssetOnly) Get the total number of non-voided assets in a given site.
Map<AssetId,List<AssetStatistics>>	getAssetsStatics(List<AssetId> assetIds) Get the statics of a list of assets.
List<AssetStatistics>	getAssetStatics(AssetId assetId, String siteName) Get the statics of a specific asset.
List<AssetId>	getCheckedOutAssets(Date startDate, Date endDate, String siteName) Get the list of assets checked out within a date range.
List<AssetId>	getCheckedOutAssets(String siteName) Get the list of assets currently checked out.
int	getContributionCountForUser(Date startDate, Date endDate, String username, String site, boolean contentAssetOnly) Get the total number of creates a user had for a given period of time for given site and/or asset type
int	getContributionCounts(Date from, Date end, String assettype, String siteName) Given an asset type and a Site, return the count of all its edits/creates for a given period of time.
List<AssetId>	getCreatedAssets(Date startDate, Date endDate, String site, boolean contentAssetsOnly) Get a list of created assets for given time period and site/asset type combination.
List<AssetId>	getCreatedAssets(Date startDate, Date endDate, String username, String site, boolean contentAssetsOnly) Get a list of created assets for given time period and site/asset type combination for a given user.
int	getCreatedCountForUser(Date startDate, Date endDate, String username, String site, boolean contentAssetsOnly) Get the total number of created assets a user had for a given period of time for given site and/or asset type.
List<AssetId>	getEditedAssets(Date startDate, Date endDate, String site, boolean contentAssetsOnly) Get a list of edited assets for given time period and site/asset type combination.
List<AssetId>	getEditedAssets(Date startDate, Date endDate, String username, String site, boolean contentAssetsOnly) Get a list of edited assets for given time period and site/asset type combination for a given user.
int	getEditedCountForUser(Date startDate, Date endDate, String username, String site, boolean contentAssetsOnly) Get the total number of edits a user had for a given period of time for given site and/or asset type.
List<AssetId>	getPlacedPages(String siteName) Get the placed assets for a given site.
Map<String,Map<PubTargetInfo,List<AssetId>>>	getPublishableHeldAssets(String siteName)
List<PubSessionStatics>	getPublishingHistory(String siteName) Get the total number of published assets for a given time period for a given site.
Map<String,Integer>	getTagsCount(String siteName) Get the top tags with number of referenced assets they have.
Map<String,Integer>	getTopAssetsCount(Date from, Date end, String siteName, int numberOfInterestedAssetTypes, boolean contentAssetsOnly) Get the asset types with most assets in given site.
Map<String,Integer>	getTopSearchesCount(Date from, Date end, String siteName, boolean contentAssetsOnly) Get a map of search text to the number of searches happened during a given period of time.
Map<String,Integer>	getTopUserContribution(Date startDate, Date endDate, int numberOfInterestedTopEdits, String site, boolean contentAssetsOnly) Get a map of username to the number of edits the user had during a specified period of time.
Map<String,Integer>	getTopUserCreates(Date startDate, Date endDate, int numberOfInterestedTopCreates, String siteName, boolean contentAssetsOnly) Get a map of username to the number of creates the user had during a specified period of time.
Map<String,Integer>	getTopUserEdits(Date startDate, Date endDate, int numberOfInterestedTopEdits, String site, boolean contentAssetsOnly) Get a map of username to the number of edits the user had during a specified period of time.
List<AssetId>	getUnplacedPages(String siteName) Get the unplaced assets for a given site.
List<AssetId>	getWorkflowAssetsHistory(Date startDate, Date endDate, String siteName, boolean contentAssetOnly) Get the workflow history for assets.

Field Detail

PUBLISHABLE

static final String PUBLISHABLE

See Also:

Constant Field Values

HELD

static final String HELD

See Also:

Constant Field Values

Method Detail

assetsCount

int assetsCount(String siteName,
                boolean contentAssetOnly)

Get the total number of non-voided assets in a given site.

Parameters:

siteName - the site name

Returns:

the total number of assets

getCheckedOutAssets

List<AssetId> getCheckedOutAssets(String siteName)

Get the list of assets currently checked out.

Parameters:

siteName - the site name

Returns:

the list of checked out assets

getCheckedOutAssets

List<AssetId> getCheckedOutAssets(Date startDate,
                                  Date endDate,
                                  String siteName)

Get the list of assets checked out within a date range.

Parameters:

startDate - The starting date of interested checked out assets.

endDate - The end date of interested checked out assets.

siteName - The site name.

Returns:

The list of checked out assets.

getWorkflowAssetsHistory

List<AssetId> getWorkflowAssetsHistory(Date startDate,
                                       Date endDate,
                                       String siteName,
                                       boolean contentAssetOnly)

Get the workflow history for assets.

Parameters:

startDate - The starting time of interested edited assets.

endDate - The end time of the interested edited assets.

siteName - The site name where the assets belong, if null, all sites will be considered.

contentAssetOnly - Specify whether content assets are needed or all the assets are needed.

Returns:

A list of assets that were in workflow.

getPublishableHeldAssets

Map<String,Map<PubTargetInfo,List<AssetId>>> getPublishableHeldAssets(String siteName)
                                                               throws Exception

Parameters:

siteName - The site name where the assets belong, if null, all sites will be considered.

Returns:

A map with keys @link PUBLISHABLE and @link HELD to a map of targetid to List of assets.

Throws:

Exception

getPublishingHistory

List<PubSessionStatics> getPublishingHistory(String siteName)

Get the total number of published assets for a given time period for a given site.

Parameters:

siteName - The site name.

Returns:

The count.

getEditedAssets

List<AssetId> getEditedAssets(Date startDate,
                              Date endDate,
                              String site,
                              boolean contentAssetsOnly)

Get a list of edited assets for given time period and site/asset type combination.

Parameters:

startDate - The starting time of interested edited assets.

endDate - The end time of the interested edited assets.

site - The site name where the assets belong, if null, all sites will be considered.

contentAssetsOnly - Specify whether content assets are needed or all the assets are needed.

Returns:

List of asset IDs.

getEditedAssets

List<AssetId> getEditedAssets(Date startDate,
                              Date endDate,
                              String username,
                              String site,
                              boolean contentAssetsOnly)

Get a list of edited assets for given time period and site/asset type combination for a given user.

Parameters:

startDate - The starting time of interested edited assets.

endDate - The end time of the interested edited assets.

username - The username of interested user.

site - The site name where the assets belong, if null, all sites will be considered.

contentAssetsOnly - Whether only content asset types are interested or not.

Returns:

List of asset ids.

getCreatedAssets

List<AssetId> getCreatedAssets(Date startDate,
                               Date endDate,
                               String site,
                               boolean contentAssetsOnly)

Get a list of created assets for given time period and site/asset type combination.

Parameters:

startDate - The starting time of interested created assets.

endDate - The end time of the interested created assets.

site - The site name where the assets belong, if null, all sites will be considered.

contentAssetsOnly - Whether only content asset types are interested or not.

Returns:

List of asset ids.

getCreatedAssets

List<AssetId> getCreatedAssets(Date startDate,
                               Date endDate,
                               String username,
                               String site,
                               boolean contentAssetsOnly)

Get a list of created assets for given time period and site/asset type combination for a given user.

Parameters:

startDate - The starting time of interested created assets.

endDate - The end time of the interested created assets.

username - The username of interested user.

site - The site name where the assets belong, if null, all sites will be considered.

contentAssetsOnly - whether only content asset types are interested or not.

Returns:

List of asset ids.

getEditedCountForUser

int getEditedCountForUser(Date startDate,
                          Date endDate,
                          String username,
                          String site,
                          boolean contentAssetsOnly)

Get the total number of edits a user had for a given period of time for given site and/or asset type.

Parameters:

startDate - The starting time of interested edited assets.

endDate - The end time of the interested edited assets.

username - The username of interested user.

site - The site name where the assets belong, if null, all sites will be considered.

contentAssetsOnly - Whether only content asset types are interested or not.

Returns:

Total number of edits.

getCreatedCountForUser

int getCreatedCountForUser(Date startDate,
                           Date endDate,
                           String username,
                           String site,
                           boolean contentAssetsOnly)

Get the total number of created assets a user had for a given period of time for given site and/or asset type.

Parameters:

startDate - The starting time of interested created assets.

endDate - The end time of the interested created assets.

username - The username of interested user.

site - The site name where the assets belong, if null, all sites will be considered.

contentAssetsOnly - whether only content asset types are interested or not.

Returns:

Total number of creates.

getTopUserEdits

Map<String,Integer> getTopUserEdits(Date startDate,
                                    Date endDate,
                                    int numberOfInterestedTopEdits,
                                    String site,
                                    boolean contentAssetsOnly)

Get a map of username to the number of edits the user had during a specified period of time.

Parameters:

startDate - The starting time of interested edited assets.

endDate - The end time of the interested edited assets.

numberOfInterestedTopEdits - The most number of users interested.

site - The site name where the assets belong, if null, all sites will be considered.

contentAssetsOnly - Whether only content asset types are interested or not.

Returns:

The map of username to total edit amount.

getTopUserContribution

Map<String,Integer> getTopUserContribution(Date startDate,
                                           Date endDate,
                                           int numberOfInterestedTopEdits,
                                           String site,
                                           boolean contentAssetsOnly)

Get a map of username to the number of edits the user had during a specified period of time.

Parameters:

startDate - The starting time of interested edited assets.

endDate - The end time of the interested edited assets.

numberOfInterestedTopEdits - The most number of users interested.

site - The site name where the assets belong, if null, all sites will be considered.

contentAssetsOnly - Whether only content asset types are interested or not.

Returns:

The map of username to total edit amount.

getContributionCountForUser

int getContributionCountForUser(Date startDate,
                                Date endDate,
                                String username,
                                String site,
                                boolean contentAssetOnly)

Get the total number of creates a user had for a given period of time for given site and/or asset type

Parameters:

startDate - The starting time of interested created assets.

endDate - The end time of the interested created assets.

username - The username of interested user.

site - The site name where the assets belong, if null, all sites will be considered.

Returns:

Total number of creates.

getTopUserCreates

Map<String,Integer> getTopUserCreates(Date startDate,
                                      Date endDate,
                                      int numberOfInterestedTopCreates,
                                      String siteName,
                                      boolean contentAssetsOnly)

Get a map of username to the number of creates the user had during a specified period of time.

Parameters:

startDate - The starting time of interested created assets.

endDate - The end time of the interested created assets.

numberOfInterestedTopCreates - The most number of users interested.

siteName - The site name where the assets belong, if null, all sites will be considered.

contentAssetsOnly - Whether only content asset types are interested or not.

Returns:

The map of username to total create amount.

getAssetStatics

List<AssetStatistics> getAssetStatics(AssetId assetId,
                                      String siteName)

Get the statics of a specific asset.

Parameters:

assetId - The asset id.

siteName -

Returns:

The asset statics.

getAssetsStatics

Map<AssetId,List<AssetStatistics>> getAssetsStatics(List<AssetId> assetIds)

Get the statics of a list of assets.

Parameters:

assetIds - List of the asset ids.

Returns:

The list of asset statics.

getPlacedPages

List<AssetId> getPlacedPages(String siteName)

Get the placed assets for a given site.

Parameters:

siteName - The site name where the assets belong, not nullable.

Returns:

A list of pages that are placed for a given site.

getUnplacedPages

List<AssetId> getUnplacedPages(String siteName)

Get the unplaced assets for a given site.

Parameters:

siteName - The site name where the assets belong, not nullable.

Returns:

A list of pages that are unplaced for a given site.

getTagsCount

Map<String,Integer> getTagsCount(String siteName)

Get the top tags with number of referenced assets they have.

Parameters:

siteName - The site where the tags are interested.

Returns:

The Map of tag name to the number of references.

getTopAssetsCount

Map<String,Integer> getTopAssetsCount(Date from,
                                      Date end,
                                      String siteName,
                                      int numberOfInterestedAssetTypes,
                                      boolean contentAssetsOnly)

Get the asset types with most assets in given site.

Parameters:

from - The start date.

end - The end date.

siteName - The site name.

numberOfInterestedAssetTypes - The number of asset types interested @return the Map of asset type name to the number of assets in the asset types.

contentAssetsOnly - Whether only content asset types are interested or not.

Returns:

A map of asset type to the number of creates/edits of that specific assets in the order of most creates/edits front.

getContributionCounts

int getContributionCounts(Date from,
                          Date end,
                          String assettype,
                          String siteName)

Given an asset type and a Site, return the count of all its edits/creates for a given period of time.

Parameters:

from - The start time.

end - The end time.

assettype - The asset type name interested.

siteName - The site name interested.

Returns:

The total count number.

getTopSearchesCount

Map<String,Integer> getTopSearchesCount(Date from,
                                        Date end,
                                        String siteName,
                                        boolean contentAssetsOnly)

Get a map of search text to the number of searches happened during a given period of time.

Parameters:

from - The starting time of interested searches.

end - The end time of the interested searches.

siteName - The site name where searches happened.

contentAssetsOnly - Whether only content asset types are interested or not.

Returns:

The map of search text to total searches amount.