ccc.api.core
Class PageCriteria

java.lang.Object
  ccc.api.core.ResourceCriteria
      ccc.api.core.PageCriteria

All Implemented Interfaces:

java.io.Serializable

public class PageCriteria
extends ResourceCriteria

Criteria class to search for pages.

Author:

Civic Computing Ltd.

See Also:

Serialized Form

Constructor Summary

PageCriteria()

Method Summary

java.util.Set<Paragraph>	getParaMatches() Accessor.
java.util.Map<java.lang.String,Range<?>>	getParaRanges() Accessor.
void	matchParagraph(java.lang.String name, boolean value) Match the specified paragraph.
void	matchParagraph(java.lang.String name, java.util.Date value) Match the specified paragraph.
void	matchParagraph(java.lang.String name, java.lang.String value) Match the specified paragraph.
void	rangeParagraph(java.lang.String name, java.util.Date from, java.util.Date to) Filter pages within a range.
void	rangeParagraph(java.lang.String name, java.lang.String from, java.lang.String to) Filter pages within a range.
void	setParaMatches(java.util.Set<Paragraph> paragraphs) Mutator.
void	setParaRanges(java.util.Map<java.lang.String,Range<?>> paraRanges) Mutator.

Methods inherited from class ccc.api.core.ResourceCriteria

getChangedAfter, getChangedBefore, getLocked, getMainmenu, getMetadata, getName, getParent, getPublished, getSortField, getSortOrder, getTag, getType, matchMetadatum, setChangedAfter, setChangedBefore, setLocked, setMainmenu, setMetadata, setName, setParent, setPublished, setSortField, setSortOrder, setTag, setType, sort

Methods inherited from class java.lang.Object

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

Constructor Detail

PageCriteria

public PageCriteria()

Method Detail

matchParagraph

public void matchParagraph(java.lang.String name,
                           java.lang.String value)

Match the specified paragraph.

Parameters:

name - The paragraph name.

value - The paragraph value.

matchParagraph

public void matchParagraph(java.lang.String name,
                           boolean value)

Match the specified paragraph.

Parameters:

name - The paragraph name.

value - The paragraph value.

matchParagraph

public void matchParagraph(java.lang.String name,
                           java.util.Date value)

Match the specified paragraph.

Parameters:

name - The paragraph name.

value - The paragraph value.

rangeParagraph

public void rangeParagraph(java.lang.String name,
                           java.util.Date from,
                           java.util.Date to)

Filter pages within a range.

Parameters:

name - The name of the paragraph to filter on.

from - The starting filter value.

to - The ending filter value.

rangeParagraph

public void rangeParagraph(java.lang.String name,
                           java.lang.String from,
                           java.lang.String to)

Filter pages within a range.

Parameters:

name - The name of the paragraph to filter on.

from - The starting filter value.

to - The ending filter value.

getParaMatches

public java.util.Set<Paragraph> getParaMatches()

Accessor.

Returns:

The paragraphs to match.

setParaMatches

public void setParaMatches(java.util.Set<Paragraph> paragraphs)

Mutator.

Parameters:

paragraphs - The paragraphs to match.

getParaRanges

public java.util.Map<java.lang.String,Range<?>> getParaRanges()

Accessor.

Returns:

The paragraph ranges.

setParaRanges

public void setParaRanges(java.util.Map<java.lang.String,Range<?>> paraRanges)

Mutator.

Parameters:

paraRanges - The paragraph ranges.