Package com.hannonhill.cascade.velocity

Class LocatorTool.SearchQuery

java.lang.Object

com.hannonhill.cascade.velocity.LocatorTool.SearchQuery

Enclosing class:

LocatorTool

public class LocatorTool.SearchQuery
extends java.lang.Object

A search query object that can be used to query for assets using the LocatorTool.

Since:

7.10

Constructor Summary

Constructors

Constructor	Description
SearchQuery()	Default constructor.

Method Summary

Modifier and Type	Method	Description
LocatorTool.SearchQuery	byContentType(java.lang.String contentTypeLink)
LocatorTool.SearchQuery	byDataDefinition(java.lang.String dataDefinitionLink)
LocatorTool.SearchQuery	byFolderPath(java.lang.String folderPath)
LocatorTool.SearchQuery	byMetadataSet(java.lang.String metadataSetLink)
LocatorTool.SearchQuery	bySiteName(java.lang.String siteName)
protected com.hannonhill.cascade.model.dao.hibernate.HibernateSearchQuery	convertToHibernateSearchQuery()
java.util.List<? extends BaseAsset>	execute()
LocatorTool.SearchQuery	hasAnyMetadataValues(java.lang.String metadataFieldName, java.util.Collection<java.lang.String> metadataFieldValues)
LocatorTool.SearchQuery	hasAnyPaths(java.util.Collection<java.lang.String> assetPaths)
LocatorTool.SearchQuery	hasAnyStructuredDataValues(java.lang.String structuredDataFieldPath, java.util.Collection<java.lang.String> structuredDataFieldValues)
LocatorTool.SearchQuery	hasAnyStructuredDataValuesByFieldId(java.lang.String structuredDataFieldId, java.util.Collection<java.lang.String> structuredDataFieldValues)
LocatorTool.SearchQuery	hasAnyTags(java.util.Collection<java.lang.String> tags)
LocatorTool.SearchQuery	hasMetadata(java.lang.String metadataFieldName, java.lang.String metadataFieldValue)
LocatorTool.SearchQuery	hasMetadata(java.lang.String metadataFieldName, java.util.Collection<java.lang.String> metadataFieldValues)	Deprecated. deprecated version of hasAnyMetadataValues(String, Collection)
LocatorTool.SearchQuery	hasStructuredData(java.lang.String structuredDataFieldPath, java.lang.String structuredDataFieldValue)
LocatorTool.SearchQuery	hasStructuredDataByFieldId(java.lang.String structuredDataFieldId, java.lang.String structuredDataFieldValue)
LocatorTool.SearchQuery	hasTag(java.lang.String tag)
LocatorTool.SearchQuery	includeBlocks(boolean includeBlocks)
LocatorTool.SearchQuery	includeFiles(boolean includeFiles)
LocatorTool.SearchQuery	includeFolders(boolean includeFolders)
LocatorTool.SearchQuery	includePages(boolean includePages)
LocatorTool.SearchQuery	includeSymlinks(boolean includeSymlinks)
LocatorTool.SearchQuery	indexableOnly(boolean indexableOnly)
LocatorTool.SearchQuery	maxResults(int maxResults)
LocatorTool.SearchQuery	preloadDynamicMetadata()
LocatorTool.SearchQuery	preloadStructuredData()
LocatorTool.SearchQuery	publishableOnly(boolean publishableOnly)
LocatorTool.SearchQuery	searchAcrossAllSites()
LocatorTool.SearchQuery	siteName(java.lang.String siteName)	Deprecated. deprecated version of bySiteName(String)
LocatorTool.SearchQuery	sortBy(java.lang.String sortBy)
LocatorTool.SearchQuery	sortDirection(java.lang.String sortDirection)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchQuery

public SearchQuery()

Default constructor.

Method Detail

hasMetadata

public LocatorTool.SearchQuery hasMetadata(java.lang.String metadataFieldName,
                                           java.lang.String metadataFieldValue)

hasMetadata

@Deprecated
public LocatorTool.SearchQuery hasMetadata(java.lang.String metadataFieldName,
                                           java.util.Collection<java.lang.String> metadataFieldValues)

Deprecated.

deprecated version of hasAnyMetadataValues(String, Collection)

hasAnyMetadataValues

public LocatorTool.SearchQuery hasAnyMetadataValues(java.lang.String metadataFieldName,
                                                    java.util.Collection<java.lang.String> metadataFieldValues)

hasStructuredData

public LocatorTool.SearchQuery hasStructuredData(java.lang.String structuredDataFieldPath,
                                                 java.lang.String structuredDataFieldValue)

hasAnyStructuredDataValues

public LocatorTool.SearchQuery hasAnyStructuredDataValues(java.lang.String structuredDataFieldPath,
                                                          java.util.Collection<java.lang.String> structuredDataFieldValues)

hasStructuredDataByFieldId

public LocatorTool.SearchQuery hasStructuredDataByFieldId(java.lang.String structuredDataFieldId,
                                                          java.lang.String structuredDataFieldValue)

hasAnyStructuredDataValuesByFieldId

public LocatorTool.SearchQuery hasAnyStructuredDataValuesByFieldId(java.lang.String structuredDataFieldId,
                                                                   java.util.Collection<java.lang.String> structuredDataFieldValues)

hasAnyTags

public LocatorTool.SearchQuery hasAnyTags(java.util.Collection<java.lang.String> tags)

hasTag

public LocatorTool.SearchQuery hasTag(java.lang.String tag)

byContentType

public LocatorTool.SearchQuery byContentType(java.lang.String contentTypeLink)

byMetadataSet

public LocatorTool.SearchQuery byMetadataSet(java.lang.String metadataSetLink)

byDataDefinition

public LocatorTool.SearchQuery byDataDefinition(java.lang.String dataDefinitionLink)

maxResults

public LocatorTool.SearchQuery maxResults(int maxResults)

sortBy

public LocatorTool.SearchQuery sortBy(java.lang.String sortBy)

sortDirection

public LocatorTool.SearchQuery sortDirection(java.lang.String sortDirection)

includePages

public LocatorTool.SearchQuery includePages(boolean includePages)

includeBlocks

public LocatorTool.SearchQuery includeBlocks(boolean includeBlocks)

includeFiles

public LocatorTool.SearchQuery includeFiles(boolean includeFiles)

includeFolders

public LocatorTool.SearchQuery includeFolders(boolean includeFolders)

includeSymlinks

public LocatorTool.SearchQuery includeSymlinks(boolean includeSymlinks)

preloadStructuredData

public LocatorTool.SearchQuery preloadStructuredData()

preloadDynamicMetadata

public LocatorTool.SearchQuery preloadDynamicMetadata()

publishableOnly

public LocatorTool.SearchQuery publishableOnly(boolean publishableOnly)

indexableOnly

public LocatorTool.SearchQuery indexableOnly(boolean indexableOnly)

siteName

@Deprecated
public LocatorTool.SearchQuery siteName(java.lang.String siteName)

Deprecated.

deprecated version of bySiteName(String)

bySiteName

public LocatorTool.SearchQuery bySiteName(java.lang.String siteName)

byFolderPath

public LocatorTool.SearchQuery byFolderPath(java.lang.String folderPath)

hasAnyPaths

public LocatorTool.SearchQuery hasAnyPaths(java.util.Collection<java.lang.String> assetPaths)

searchAcrossAllSites

public LocatorTool.SearchQuery searchAcrossAllSites()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

execute

public java.util.List<? extends BaseAsset> execute()

convertToHibernateSearchQuery

protected com.hannonhill.cascade.model.dao.hibernate.HibernateSearchQuery convertToHibernateSearchQuery()

Returns:

Generates and returns HibernateSearchQuery with equivalent parameters set.