com.jalios.jcms.db

Class PublicationCriteria

java.lang.Object

com.jalios.jcms.db.PublicationCriteria

All Implemented Interfaces:

DBConstants, JaliosConstants

public class PublicationCriteria
extends java.lang.Object
implements JaliosConstants, DBConstants

This class contains criteria for a DB publication query.

Since:

jcms-6.0.0

Author:

Olivier Dedieu

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	REVISION

Fields inherited from interface com.jalios.util.JaliosConstants

CRLF, MILLIS_IN_ONE_DAY, MILLIS_IN_ONE_HOUR, MILLIS_IN_ONE_MINUTE, MILLIS_IN_ONE_MONTH, MILLIS_IN_ONE_SECOND, MILLIS_IN_ONE_WEEK, MILLIS_IN_ONE_YEAR

Fields inherited from interface com.jalios.jcms.db.DBConstants

ALL_CATEGORIES_SET_FIELD, AUTH_GRP_SET_FIELD, AUTH_MBR_SET_FIELD, AUTHOR_ID_FIELD, CATEGORIES_SET_FIELD, CDATE_FIELD, CHANNEL_JCMSDB_PROP, DBDATA_URID, HAS_NO_READ_RIGHTS, HIBERNATE_MAPPING_ADATE, HIBERNATE_MAPPING_AUTHOR, HIBERNATE_MAPPING_CDATE, HIBERNATE_MAPPING_EDATE, HIBERNATE_MAPPING_MDATE, HIBERNATE_MAPPING_PDATE, HIBERNATE_MAPPING_PSTATUS, HIBERNATE_MAPPING_TITLE, HIBERNATE_MAPPING_WORKFLOW_ID, HIBERNATE_MAPPING_WORKSPACE_ID, MDATE_FIELD, PSTATUS_FIELD, ROW_ID_FIELD, SCROLL_FETCH_SIZE, WORKFLOW_ID_FIELD, WORKSPACE_ID_FIELD

Constructor Summary

Constructors

Constructor and Description
PublicationCriteria(java.lang.Class<? extends Publication> clazz)
PublicationCriteria(java.lang.Class<? extends Publication> clazz, QueryHandler qh)

Method Summary

Methods

Modifier and Type	Method and Description
org.hibernate.Criteria	buildCriteria(boolean count)
boolean	checkReadRights()
java.lang.String	getAuthorId()
java.util.Date	getBeginDate()
java.lang.String	getDateType()
java.util.Date	getEndDate()
int	getFirstResult()
int	getMaxResults()
Member	getMember()
java.util.Comparator	getMergeComparator() Returns the merge comparator used to sort hybrid search.
java.lang.String	getOrder()
int[]	getPstatusArray()
java.lang.Class<? extends Publication>	getPubClass()
QueryHandler	getQueryHandler()
java.lang.String	getText()
java.lang.String	getWorkspaceId() Use instead getWorkspaceIdSet().
java.util.Set<java.lang.String>	getWorkspaceIdSet()
boolean	hasAdvancedLuceneQuery() Returns true if there is an advanced lucene query to be performed.
boolean	isAscendingOrder()
boolean	isHybridSearch()
boolean	isIncludePstatus()
boolean	isPolymorphicQuery()
boolean	isTextSearch() Returns true if the text parameter has been setup.
PublicationCriteria	setAscendingOrder(boolean ascendingOrder)
PublicationCriteria	setAuthor(Member author)
PublicationCriteria	setAuthorId(java.lang.String authorId)
PublicationCriteria	setBeginDate(java.util.Date beginDate)
PublicationCriteria	setCustomCriterion(org.hibernate.criterion.Criterion customCriterion)
PublicationCriteria	setDateType(java.lang.String dateType)
PublicationCriteria	setEndDate(java.util.Date endDate)
void	setFilterOnMemberWorkspaces(boolean filterOnMemberWorkspaces)
PublicationCriteria	setFirstResult(int firstResult)
void	setHybridSearch(boolean isHybridSearch)
PublicationCriteria	setIncludePstatus(boolean includePstatus)
PublicationCriteria	setMaxResults(int maxResults)
void	setMember(Member member)
PublicationCriteria	setMergeComparator(java.util.Comparator mergeComparator) Set the merge comparator to be used to sort hybrid search (and set the isHybridSearch flag)
PublicationCriteria	setOrder(java.lang.String order)
PublicationCriteria	setPstatusArray(int[] pstatusArray)
PublicationCriteria	setPubClass(java.lang.Class<? extends Publication> clazz)
PublicationCriteria	setQueryHandler(QueryHandler qh)
PublicationCriteria	setRowIdSet(java.util.Set<java.lang.Long> rowIdSet)
PublicationCriteria	setText(java.lang.String text)
PublicationCriteria	setWorkspace(Workspace workspace) Use instead setWorkspaceIdSet(Collection).
PublicationCriteria	setWorkspaceId(java.lang.String workspaceId) Use instead setWorkspaceIdSet(Collection).
void	setWorkspaceIdSet(java.util.Collection<java.lang.String> wsIds)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

REVISION

public static final java.lang.String REVISION

See Also:

Constant Field Values

Constructor Detail

PublicationCriteria

public PublicationCriteria(java.lang.Class<? extends Publication> clazz)

PublicationCriteria

public PublicationCriteria(java.lang.Class<? extends Publication> clazz,
                   QueryHandler qh)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

buildCriteria

public org.hibernate.Criteria buildCriteria(boolean count)

isTextSearch

public boolean isTextSearch()

Returns true if the text parameter has been setup.

Returns:

true if the text parameter has been setup.

Since:

jcms-6.0.0

hasAdvancedLuceneQuery

public boolean hasAdvancedLuceneQuery()

Returns true if there is an advanced lucene query to be performed.

Returns:

true if there is an advanced lucene query to be performed.

Since:

jcms-6.2.0

getPubClass

public java.lang.Class<? extends Publication> getPubClass()

setPubClass

public PublicationCriteria setPubClass(java.lang.Class<? extends Publication> clazz)

getQueryHandler

public QueryHandler getQueryHandler()

setQueryHandler

public PublicationCriteria setQueryHandler(QueryHandler qh)

getWorkspaceId

public java.lang.String getWorkspaceId()

Use instead getWorkspaceIdSet().

Returns:

the workspace id to refine on.

setWorkspaceId

public PublicationCriteria setWorkspaceId(java.lang.String workspaceId)

Use instead setWorkspaceIdSet(Collection).

Parameters:

workspaceId - the workspace id to refine on.

Returns:

the publication criteria.

setWorkspace

public PublicationCriteria setWorkspace(Workspace workspace)

Use instead setWorkspaceIdSet(Collection).

Parameters:

workspace - the workspace to refine on.

Returns:

the publication criteria.

setWorkspaceIdSet

public void setWorkspaceIdSet(java.util.Collection<java.lang.String> wsIds)

Parameters:

wsIds - the set of workspace's ids to refine on.

Since:

jcms-7.1.3, jcms-8.0.0

getWorkspaceIdSet

public java.util.Set<java.lang.String> getWorkspaceIdSet()

Returns:

the workspaceIdSet to refine on.

Since:

jcms-7.1.3, jcms-8.0.0

getAuthorId

public java.lang.String getAuthorId()

setAuthorId

public PublicationCriteria setAuthorId(java.lang.String authorId)

setAuthor

public PublicationCriteria setAuthor(Member author)

setFilterOnMemberWorkspaces

public void setFilterOnMemberWorkspaces(boolean filterOnMemberWorkspaces)

getPstatusArray

public int[] getPstatusArray()

setPstatusArray

public PublicationCriteria setPstatusArray(int[] pstatusArray)

isIncludePstatus

public boolean isIncludePstatus()

setIncludePstatus

public PublicationCriteria setIncludePstatus(boolean includePstatus)

getText

public java.lang.String getText()

setText

public PublicationCriteria setText(java.lang.String text)

getBeginDate

public java.util.Date getBeginDate()

setBeginDate

public PublicationCriteria setBeginDate(java.util.Date beginDate)

getEndDate

public java.util.Date getEndDate()

setEndDate

public PublicationCriteria setEndDate(java.util.Date endDate)

getDateType

public java.lang.String getDateType()

setDateType

public PublicationCriteria setDateType(java.lang.String dateType)

setRowIdSet

public PublicationCriteria setRowIdSet(java.util.Set<java.lang.Long> rowIdSet)

setMember

public void setMember(Member member)

getMember

public Member getMember()

checkReadRights

public boolean checkReadRights()

getFirstResult

public int getFirstResult()

setFirstResult

public PublicationCriteria setFirstResult(int firstResult)

getMaxResults

public int getMaxResults()

setMaxResults

public PublicationCriteria setMaxResults(int maxResults)

getOrder

public java.lang.String getOrder()

setOrder

public PublicationCriteria setOrder(java.lang.String order)

isAscendingOrder

public boolean isAscendingOrder()

setAscendingOrder

public PublicationCriteria setAscendingOrder(boolean ascendingOrder)

setCustomCriterion

public PublicationCriteria setCustomCriterion(org.hibernate.criterion.Criterion customCriterion)

getMergeComparator

public java.util.Comparator getMergeComparator()

Returns the merge comparator used to sort hybrid search. If no comparator has been provided, it is deduced from getOrder() and isAscendingOrder().

Returns:

the merge comparator

Since:

jcms-7.0.0

setMergeComparator

public PublicationCriteria setMergeComparator(java.util.Comparator mergeComparator)

Set the merge comparator to be used to sort hybrid search (and set the isHybridSearch flag)

Parameters:

mergeComparator - the merge comparator

Returns:

this PublicationCriteria for chained invocation

Since:

jcms-7.0.0

isHybridSearch

public boolean isHybridSearch()

setHybridSearch

public void setHybridSearch(boolean isHybridSearch)

isPolymorphicQuery

public boolean isPolymorphicQuery()