Query

pink.cozydev.lucille.Query
See theQuery companion trait
object Query

Attributes

Companion
trait
Source
Query.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Query.type

Members list

Type members

Classlikes

sealed abstract case class And extends Query

An And operator Join the given queries with AND, the equivalent of taking the intersection of the results of each query e.g.

An And operator Join the given queries with AND, the equivalent of taking the intersection of the results of each query e.g. 'q1 AND q2'

Value parameters

qs

the queries to intersect

Attributes

Companion
object
Source
Query.scala
Supertypes
trait Query
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object And

Attributes

Companion
class
Source
Query.scala
Supertypes
class Object
trait Matchable
class Any
Self type
And.type
final case class Boost(q: Query, boost: Float) extends Query

A query with a boost weight Search for documents with the underlying query as usual, the boost is only used in scoring e.g.

A query with a boost weight Search for documents with the underlying query as usual, the boost is only used in scoring e.g. 'cats2 OR dogs3.1'

Value parameters

boost

the boost weight

q

the query

Attributes

Source
Query.scala
Supertypes
trait Query
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class Field(field: String, q: Query) extends Query

A field query Search for documents by applying the given query only to the named field e.g.

A field query Search for documents by applying the given query only to the named field e.g. 'author:"Silly Goose"', 'title:(cats AND dogs)'

Value parameters

field

the field name

q

the query

Attributes

Source
Query.scala
Supertypes
trait Query
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class Fuzzy(str: String, num: Option[Int]) extends TermQuery

A fuzzy query with an optional distance value e.g.

A fuzzy query with an optional distance value e.g. 'cat\~', 'cat\~1'

Value parameters

num

the number of edits allowed

str

the string

Attributes

Source
Query.scala
Supertypes
trait TermQuery
trait Query
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class Group(q: Query) extends Query

A group query Queries grouped together with parentheses e.g.

A group query Queries grouped together with parentheses e.g. '(cats AND dogs)'

Value parameters

qs

the queries to group

Attributes

Source
Query.scala
Supertypes
trait Query
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class MinimumMatch(qs: NonEmptyList[Query], num: Int) extends Query

A minimum match query Search for documents that match at least num of the given queries e.g.

A minimum match query Search for documents that match at least num of the given queries e.g. '(one two three)@2'

Value parameters

num

the number of queries that must match

qs

the queries

Attributes

Source
Query.scala
Supertypes
trait Query
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class Not(q: Query) extends Query

A Not operator Exclude terms that would match the given query e.g.

A Not operator Exclude terms that would match the given query e.g. 'NOT cats'

Value parameters

q

the query to exclude

Attributes

Source
Query.scala
Supertypes
trait Query
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed abstract case class Or extends Query

An Or operator Join the given queries with OR, the equivalent of taking the union of the results of each query e.g.

An Or operator Join the given queries with OR, the equivalent of taking the union of the results of each query e.g. 'q1 OR q2'

Value parameters

qs

the queries to union

Attributes

Companion
object
Source
Query.scala
Supertypes
trait Query
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Or

Attributes

Companion
class
Source
Query.scala
Supertypes
class Object
trait Matchable
class Any
Self type
Or.type
final case class Phrase(str: String) extends TermQuery

A phrase query e.g.

A phrase query e.g. 'the cat jumped'

Value parameters

str

the phrase

Attributes

Source
Query.scala
Supertypes
trait TermQuery
trait Query
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class Prefix(str: String) extends TermQuery

A prefix query Search for words starting with the given prefix e.g.

A prefix query Search for words starting with the given prefix e.g. 'jump*'

Value parameters

str

the prefix

Attributes

Source
Query.scala
Supertypes
trait TermQuery
trait Query
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class Proximity(str: String, num: Int) extends TermQuery

A proximity query Search for words within a specified word distance e.g.

A proximity query Search for words within a specified word distance e.g. '"cat jumped"\~3', '"one two three"\~2'

Value parameters

num

the word distance

str

the words

Attributes

Source
Query.scala
Supertypes
trait TermQuery
trait Query
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class Term(str: String) extends TermQuery

A term query e.g.

A term query e.g. 'cat', 'catch22'

Value parameters

str

the term

Attributes

Source
Query.scala
Supertypes
trait TermQuery
trait Query
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class TermRange(lower: Option[String], upper: Option[String], lowerInc: Boolean, upperInc: Boolean) extends TermQuery

A range query Search for terms that fall between some upper and lower bounds.

A range query Search for terms that fall between some upper and lower bounds. The bounds can be inclusive or exclusive. e.g. '{cats TO dogs}', '[1 TO *]'

Value parameters

lower

the lower bound

lowerInc

whether the lower bound is inclusive

upper

the upper bound

upperInc

whether the upper bound is inclusive

Attributes

Source
Query.scala
Supertypes
trait TermQuery
trait Query
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class TermRegex(str: String) extends TermQuery

A regex query Search with a regular expression, the pattern is given between forward slashes, /.

A regex query Search with a regular expression, the pattern is given between forward slashes, /. e.g. '/.ump(s|ing)'

Value parameters

str

the regular expression query

Attributes

Source
Query.scala
Supertypes
trait TermQuery
trait Query
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class UnaryMinus(q: Query) extends Query

A unary minus query Search for documents which must not contain the given query e.g.

A unary minus query Search for documents which must not contain the given query e.g. '-cat', '-(cats AND dogs)'

Value parameters

q

the query

Attributes

Source
Query.scala
Supertypes
trait Query
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class UnaryPlus(q: Query) extends Query

A unary plus query Search for documents which must contain the given query e.g.

A unary plus query Search for documents which must contain the given query e.g. '+cat', '+(cats AND dogs)'

Value parameters

q

the query

Attributes

Source
Query.scala
Supertypes
trait Query
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class WildCard(ops: NonEmptyList[WildCardOp]) extends TermQuery

Attributes

Source
Query.scala
Supertypes
trait TermQuery
trait Query
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object WildCardOp

Attributes

Companion
trait
Source
Query.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
WildCardOp.type
sealed trait WildCardOp extends Product, Serializable

Attributes

Companion
object
Source
Query.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
object ManyChar
object SingleChar
class Str