com.fatwire.assetapi.query

Interface AssetStatisticsSearcher

All Known Implementing Classes:

AssetStatisticsSearcherImpl

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 inclued 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 creates 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 asstes 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 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

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