org.ametys.cms.search.query

Interface Query

All Known Implementing Classes:

AbstractFieldQuery, AbstractGroupsQuery, AbstractUsersQuery, AndQuery, BooleanQuery, BoostedQuery, ChildPageQuery, CollectionsQuery, CommentQuery, ConstantNilScoreQuery, ContentAttachmentQuery, ContentLanguageQuery, ContentPageQuery, ContentPrivacyQuery, ContentQuery, ContentTypeOrMixinTypeQuery, ContentTypeQuery, CreationDateQuery, DateQuery, DateRangeQuery, DescendantPageQuery, DocumentTypeQuery, DoubleQuery, DoubleRangeQuery, DublinCoreDateQuery, DublinCoreQuery, EntryPositionQuery, FilenameQuery, FirstValidationDateQuery, FrontODFSearch.SubProgramPageContentQuery, FullTextQuery, HistoryStepQuery, JoinQuery, KeywordQuery, LastMajorValidationDateQuery, LastModifiedQuery, LastValidationDateQuery, LongQuery, LongRangeQuery, MatchAllQuery, MatchNoneQuery, MaxScoreOrQuery, MixinTypeQuery, NotQuery, OrphanQuery, OrQuery, PageAttachmentQuery, PageContentQuery, PageIdQuery, PageQuery, ProgramSearchable.ProgramThroughProgramPartsQuery, ProjectQuery, ResourceLocationQuery, SearchResourcesGenerator.ResourceCreatorQuery, SharedQuery, SitemapQuery, SiteQuery, SiteTypeQuery, SolrNativeJoinQuery, StringQuery, SubContentQuery, TagQuery, UsersQuery, WorkflowStepQuery

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface Query

Represents a search predicate.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Query.LogicalOperator Enumeration of available logical operators in Query
static class	Query.Operator Enumeration of available operators in Query

Method Summary

Modifier and Type	Method and Description
String	build() Build the solr query string representing the Query object.
default String	toString(int indent) Gets a representation of this Query, for pretty-printing for logging and debugging purposes

Method Detail

build

String build()
      throws QuerySyntaxException

Build the solr query string representing the Query object.

Returns:

the solr query string representing the Query object.

Throws:

QuerySyntaxException - if the query can't be built because of a syntax error.

toString

default String toString(int indent)

Gets a representation of this Query, for pretty-printing for logging and debugging purposes

Parameters:

indent - The current indentation. Base indentation is 2 (for printing a sub-level)

Returns:

a representation of this Query