com.fatwire.assetapi.query

Class AssetStatisticsSearcherImpl

java.lang.Object

com.fatwire.assetapi.query.AssetStatisticsSearcherImpl

All Implemented Interfaces:

AssetStatisticsSearcher

public class AssetStatisticsSearcherImpl
extends Object
implements AssetStatisticsSearcher

Field Summary

Fields inherited from interface com.fatwire.assetapi.query.AssetStatisticsSearcher

HELD, PUBLISHABLE

Constructor Summary

Constructors

Constructor and Description
AssetStatisticsSearcherImpl(ICS ics)

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 contentAssetOnly) 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 contentAssetOnly) 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 contentAssetOnly) 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 contentAssetOnly) 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 contentAssetOnly) 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 contentAssetOnly) 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 site) 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 contentAssetOnly) 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 contentAssetOnly) 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 site, boolean contentAssetOnly) 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 contentAssetOnly) Get a map of username to the number of edits the user had during a specified period of time
List<AssetId>	getUnplacedPages(String site) 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

Methods inherited from class java.lang.Object

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

Constructor Detail

AssetStatisticsSearcherImpl

public AssetStatisticsSearcherImpl(ICS ics)

Method Detail

assetsCount

public int assetsCount(String siteName,
                       boolean contentAssetOnly)

Description copied from interface: AssetStatisticsSearcher

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

Specified by:

assetsCount in interface AssetStatisticsSearcher

Parameters:

siteName - the site name

Returns:

the total number of assets

getCheckedOutAssets

public List<AssetId> getCheckedOutAssets(String siteName)

Description copied from interface: AssetStatisticsSearcher

get the list of assets currently checked out

Specified by:

getCheckedOutAssets in interface AssetStatisticsSearcher

Parameters:

siteName - the site name

Returns:

the list of checked out assets

getCheckedOutAssets

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

Description copied from interface: AssetStatisticsSearcher

get the list of assets checked out within a date range

Specified by:

getCheckedOutAssets in interface AssetStatisticsSearcher

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

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

Description copied from interface: AssetStatisticsSearcher

Get the workflow history for assets

Specified by:

getWorkflowAssetsHistory in interface AssetStatisticsSearcher

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

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

Specified by:

getPublishableHeldAssets in interface AssetStatisticsSearcher

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

public List<PubSessionStatics> getPublishingHistory(String siteName)

Description copied from interface: AssetStatisticsSearcher

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

Specified by:

getPublishingHistory in interface AssetStatisticsSearcher

Parameters:

siteName - the site name

Returns:

the count

getEditedAssets

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

Description copied from interface: AssetStatisticsSearcher

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

Specified by:

getEditedAssets in interface AssetStatisticsSearcher

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

contentAssetOnly - specify whether content assets are needed or all the assets are needed

Returns:

list of asset ids

getEditedAssets

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

Description copied from interface: AssetStatisticsSearcher

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

Specified by:

getEditedAssets in interface AssetStatisticsSearcher

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

contentAssetOnly - whether only content asset types are interested or not

Returns:

list of asset ids

getCreatedAssets

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

Description copied from interface: AssetStatisticsSearcher

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

Specified by:

getCreatedAssets in interface AssetStatisticsSearcher

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

contentAssetOnly - whether only content asset types are interested or not

Returns:

list of asset ids

getCreatedAssets

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

Description copied from interface: AssetStatisticsSearcher

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

Specified by:

getCreatedAssets in interface AssetStatisticsSearcher

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

contentAssetOnly - whether only content asset types are interested or not

Returns:

list of asset ids

getEditedCountForUser

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

Description copied from interface: AssetStatisticsSearcher

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

Specified by:

getEditedCountForUser in interface AssetStatisticsSearcher

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

contentAssetOnly - whether only content asset types are interested or not

Returns:

total number of edits

getCreatedCountForUser

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

Description copied from interface: AssetStatisticsSearcher

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

Specified by:

getCreatedCountForUser in interface AssetStatisticsSearcher

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

contentAssetOnly - whether only content asset types are interested or not

Returns:

total number of creates

getTopUserEdits

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

Description copied from interface: AssetStatisticsSearcher

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

Specified by:

getTopUserEdits in interface AssetStatisticsSearcher

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

contentAssetOnly - whether only content asset types are interested or not

Returns:

the map of username to total edit amount

getTopUserContribution

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

Description copied from interface: AssetStatisticsSearcher

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

Specified by:

getTopUserContribution in interface AssetStatisticsSearcher

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

contentAssetOnly - whether only content asset types are interested or not

Returns:

the map of username to total edit amount

getContributionCountForUser

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

Description copied from interface: AssetStatisticsSearcher

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

Specified by:

getContributionCountForUser in interface AssetStatisticsSearcher

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

public Map<String,Integer> getTopUserCreates(Date startDate,
                                             Date endDate,
                                             int numberOfInterestedTopCreates,
                                             String site,
                                             boolean contentAssetOnly)

Description copied from interface: AssetStatisticsSearcher

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

Specified by:

getTopUserCreates in interface AssetStatisticsSearcher

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

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

contentAssetOnly - whether only content asset types are interested or not

Returns:

the map of username to total create amount

getAssetStatics

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

Description copied from interface: AssetStatisticsSearcher

Get the statics of a specific asset

Specified by:

getAssetStatics in interface AssetStatisticsSearcher

Parameters:

assetId - the asset id

Returns:

the asset statics

getAssetsStatics

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

Description copied from interface: AssetStatisticsSearcher

Get the statics of a list of assets

Specified by:

getAssetsStatics in interface AssetStatisticsSearcher

Parameters:

assetIds - list of the asset ids

Returns:

the list of asset statics

getPlacedPages

public List<AssetId> getPlacedPages(String site)

Description copied from interface: AssetStatisticsSearcher

Get the placed assets for a given site

Specified by:

getPlacedPages in interface AssetStatisticsSearcher

Parameters:

site - the site name where the assets belong, not nullable

Returns:

a list of pages that are placed for a given site

getUnplacedPages

public List<AssetId> getUnplacedPages(String site)

Description copied from interface: AssetStatisticsSearcher

Get the unplaced asstes for a given site

Specified by:

getUnplacedPages in interface AssetStatisticsSearcher

Parameters:

site - the site name where the assets belong, not nullable

Returns:

a list of pages that are unplaced for a given site

getTagsCount

public Map<String,Integer> getTagsCount(String siteName)

Description copied from interface: AssetStatisticsSearcher

Get the top tags with number of referenced assets they have

Specified by:

getTagsCount in interface AssetStatisticsSearcher

Parameters:

siteName - the site where the tags are interested

Returns:

the Map of tag name to the number of references

getTopAssetsCount

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

Description copied from interface: AssetStatisticsSearcher

Get the asset types with most assets in given site

Specified by:

getTopAssetsCount in interface AssetStatisticsSearcher

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

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

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

Description copied from interface: AssetStatisticsSearcher

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

Specified by:

getContributionCounts in interface AssetStatisticsSearcher

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

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

Description copied from interface: AssetStatisticsSearcher

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

Specified by:

getTopSearchesCount in interface AssetStatisticsSearcher

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