Package com.marklogic.client.pojo

Interface PojoQueryBuilder<T>

public interface PojoQueryBuilder<T>

Specific to pojos yet similar to StructuredQueryBuilder, this class generates structured queries. It adds convenience methods specific to working with pojos and does not replicate StructuredQueryBuilder methods that don't make sense for pojos. The goal of the pojo facade is to simplify working with custom pojos. PojoQueryBuilder keeps all the powerful queries available via StructuredQueryBuilder while enabling queries across objects persisted using PojoRepository.

For methods which accept a "pojoProperty" argument we are refering to properties appropriate for JavaBeans, including properties accessible via public getters and setters, or public fields.

Where StructuredQueryBuilder accepts StructuredQueryBuilder.TextIndex as a first argument to value(TextIndex, String...) and word(TextIndex, String...) methods, PojoQueryBuilder adds shortcut methods which accept as the first argument a String name of the pojoProperty. Similarly, PojoQueryBuilder accepts String pojoProperty arguments wherever StructuredQueryBuilder accepts StructuredQueryBuilder.Element, StructuredQueryBuilder.Attribute, and StructuredQueryBuilder.PathIndex as arguments to geoAttributePair(Element, Attribute, Attribute), geoElement(Element), geoElement(Element, Element), geoElementPair(Element, Element, Element), geoPath(PathIndex)

Here are a couple examples. Without the pojo facade you might persist your products using JacksonDatabindHandle and query the json property thusly:

   StructuredQueryBuilder sqb = new StructuredQueryBuilder();
    QueryDefinition query = sqb.value(sqb.jsonProperty("productId"), 12345);

If you use PojoRepository to persist your products, you can query more simply:

   PojoQueryBuilder pqb = pojoRepository.getQueryBuilder();
    QueryDefinition query = pqb.value("productId", 12345);

Similarly, without the pojo facade you might persist your pojos using JAXBHandle and if they have a geoPosition property which is an object with latitude and longitude pojoProperty's (which persist as elements) you might query them thusly:

   StructuredQueryBuilder sqb = new StructuredQueryBuilder();
    StructuredQueryBuilder.GeospatialIndex geoIdx = sqb.geoElementPair(
      sqb.element("geoPosition"), sqb.element("latitude"), sqb.element("longitude"));

But if you use PojoRepository to persist your pojos with a latitude and longitude pojoProperty's, you can query them more simply:

   PojoQueryBuilder pqb = pojoRepository.getQueryBuilder();
    StructuredQueryBuilder.GeospatialIndex geoIdx =
      pqb.geoPair("latitude", "longitude");

As custom pojos may have nested pojos, PojoQueryBuilder also makes it easy to query those nested pojos. For example, if you had the following classes:

    class City {
     @Id int id;
      Country country;
      int getId();
      void setId(int id);
      Country getCountry();
      void setCountry(Country country);
    }
    class Country {
      String continent;
      String getContinent();
      void setContinent();
    }

That is, you have a pojo class City with a property "country" of type Country, you could query properties on the nested country thusly:

   PojoRepository<City, Integer> cities =
      databaseClient.newPojoRepository(City.class, Integer.class);
    PojoQueryBuilder<City> citiesQb = cities.getQueryBuilder();
    PojoQueryBuilder<Country> countriesQb = citiesQb.containerQueryBuilder("country", Country.class);
    QueryDefinition query = countriesQb.value("continent", "EU"); 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	PojoQueryBuilder.Operator	Copied directly from StructuredQueryBuilder.Operator.

Method Summary

Modifier and Type	Method	Description
StructuredQueryDefinition	and(StructuredQueryDefinition... queries)	Copied directly from StructuredQuerybuilder.and.
StructuredQueryDefinition	andNot(StructuredQueryDefinition positive, StructuredQueryDefinition negative)	Copied directly from StructuredQuerybuilder.andNot.
StructuredQueryDefinition	boost(StructuredQueryDefinition matchingQuery, StructuredQueryDefinition boostingQuery)	Copied directly from StructuredQuerybuilder.boost.
StructuredQueryBuilder.Region	box(double south, double west, double north, double east)	Copied directly from StructuredQuerybuilder.box.
RawStructuredQueryDefinition	build(StructuredQueryDefinition... queries)	Copied directly from StructuredQuerybuilder.build.
StructuredQueryBuilder.Region	circle(double latitude, double longitude, double radius)	Copied directly from StructuredQuerybuilder.circle(double, double, double).
StructuredQueryBuilder.Region	circle(StructuredQueryBuilder.Point center, double radius)	Copied directly from StructuredQuerybuilder.circle(StructuredQueryBuilder.Point, double).
StructuredQueryDefinition	collection(java.lang.String... uris)	Copied directly from StructuredQuerybuilder.collection(String...).
StructuredQueryDefinition	containerQuery(java.lang.String pojoProperty, StructuredQueryDefinition query)
<C> PojoQueryBuilder<C>	containerQueryBuilder(java.lang.String pojoProperty, java.lang.Class<C> clazz)	Use this method to provide a query builder that can query a nested object within your pojo.
PojoQueryDefinition	filteredQuery(StructuredQueryDefinition query)	Wraps the structured query into a combined query with options containing <search-option>filtered</search-option> so results are accurate though slower.
StructuredQueryBuilder.GeospatialIndex	geoPair(java.lang.String latitudePropertyName, java.lang.String longitudePropertyName)	For use in a geospatial query, reference a pair of properties.
StructuredQueryBuilder.GeospatialIndex	geoPath(java.lang.String pojoProperty)	For use in a geospatial query, reference a geo property which has a corresponding Geospatial Path Range Index configured in the database.
StructuredQueryDefinition	geospatial(StructuredQueryBuilder.GeospatialIndex index, StructuredQueryBuilder.Region... regions)	Copied directly from StructuredQuerybuilder.geospatial(StructuredQueryBuilder.GeospatialIndex, StructuredQueryBuilder.Region...).
StructuredQueryDefinition	geospatial(StructuredQueryBuilder.GeospatialIndex index, java.lang.String[] options, StructuredQueryBuilder.Region... regions)	Copied from StructuredQuerybuilder.geospatial(StructuredQueryBuilder.GeospatialIndex, StructuredQueryBuilder.FragmentScope, String[], StructuredQueryBuilder.Region...) but without StructuredQueryBuilder.FragmentScope.
StructuredQueryDefinition	near(int distance, double weight, StructuredQueryBuilder.Ordering order, StructuredQueryDefinition... queries)	Copied directly from StructuredQuerybuilder.near(int, double, StructuredQueryBuilder.Ordering, StructuredQueryDefinition...).
StructuredQueryDefinition	near(StructuredQueryDefinition... queries)	Copied directly from StructuredQuerybuilder.near(StructuredQueryDefinition...).
StructuredQueryDefinition	not(StructuredQueryDefinition query)	Copied directly from StructuredQuerybuilder.not.
StructuredQueryDefinition	notIn(StructuredQueryDefinition positive, StructuredQueryDefinition negative)	Copied directly from StructuredQuerybuilder.and.
StructuredQueryDefinition	or(StructuredQueryDefinition... queries)	Copied directly from StructuredQuerybuilder.and.
StructuredQueryBuilder.Region	point(double latitude, double longitude)	Copied directly from StructuredQuerybuilder.point.
StructuredQueryBuilder.Region	polygon(StructuredQueryBuilder.Point... points)	Copied directly from StructuredQuerybuilder.polygon.
StructuredQueryDefinition	range(java.lang.String pojoProperty, PojoQueryBuilder.Operator operator, java.lang.Object... values)	Query a Path Range Index configured in the database for a pojo property.
StructuredQueryDefinition	range(java.lang.String pojoProperty, java.lang.String[] options, PojoQueryBuilder.Operator operator, java.lang.Object... values)	Query a Path Range Index configured in the database for a pojo property.
StructuredQueryDefinition	term(double weight, java.lang.String... terms)	Copied directly from StructuredQuerybuilder.term(double, String...).
StructuredQueryDefinition	term(java.lang.String... terms)	Copied directly from StructuredQuerybuilder.term(String...).
StructuredQueryDefinition	value(java.lang.String pojoProperty, java.lang.Boolean value)	Filter search results by properties matching specified value.
StructuredQueryDefinition	value(java.lang.String pojoProperty, java.lang.Number... values)	Filter search results by properties matching specified values.
StructuredQueryDefinition	value(java.lang.String pojoProperty, java.lang.String... values)	Filter search results by properties matching specified values.
StructuredQueryDefinition	value(java.lang.String pojoProperty, java.lang.String[] options, double weight, java.lang.Boolean value)	Filter search results by properties matching specified values.
StructuredQueryDefinition	value(java.lang.String pojoProperty, java.lang.String[] options, double weight, java.lang.Number... values)	Filter search results by properties matching specified values.
StructuredQueryDefinition	value(java.lang.String pojoProperty, java.lang.String[] options, double weight, java.lang.String... values)	Filter search results by properties matching specified values.
StructuredQueryDefinition	word(java.lang.String pojoProperty, java.lang.String... words)	Filter search results by properties with at least one of the specified words or phrases.
StructuredQueryDefinition	word(java.lang.String pojoProperty, java.lang.String[] options, double weight, java.lang.String... words)	Filter search results by properties with at least one of the specified words or phrases.

Method Detail

containerQuery

StructuredQueryDefinition containerQuery(java.lang.String pojoProperty,
                                         StructuredQueryDefinition query)

Parameters:

pojoProperty - the property container to match against

query - the query to match within the container

Returns:

a query matching pojos of type T containing the pojoProperty with contents or children matching the specified query

containerQueryBuilder

<C> PojoQueryBuilder<C> containerQueryBuilder(java.lang.String pojoProperty,
                                              java.lang.Class<C> clazz)

Use this method to provide a query builder that can query a nested object within your pojo. All other PojoQueryBuilder methods create queries for direct children of T which are native types. If a child of T is a pojo, and you need to query one of its children, this method provides you a query builder that is specific to that child object. To query further levels of nested objects you may use this method on the each returned PojoQueryBuilder which represents one level deeper.

Type Parameters:

C - the type of the class contained by pojoProperty

Parameters:

pojoProperty - the name of a field or JavaBean property (accessed via getter or setter) on class T that is a pojo of type clazz

clazz - the class type of the nested pojo

Returns:

a PojoQueryBuilder for nested pojos of the type corresponding with pojoProperty

geoPair

StructuredQueryBuilder.GeospatialIndex geoPair(java.lang.String latitudePropertyName,
                                               java.lang.String longitudePropertyName)

For use in a geospatial query, reference a pair of properties. These properties should ideally have Geospatial Element Pair Indexes configured in the database. For help creating these indexes, see GenerateIndexConfig, GeospatialLatitude, and GeospatialLongitude.

Parameters:

latitudePropertyName - the name of a field or JavaBean property (accessed via getter or setter) ideally annotated with @GeospatialLatitude

longitudePropertyName - the name of a field or JavaBean property (accessed via getter or setter) ideally annotated with @GeospatialLongitude

Returns:

the geospatial element pair range query

geoPath

StructuredQueryBuilder.GeospatialIndex geoPath(java.lang.String pojoProperty)

For use in a geospatial query, reference a geo property which has a corresponding Geospatial Path Range Index configured in the database. For help creating this index, see GenerateIndexConfig and GeospatialPathIndexProperty.

Parameters:

pojoProperty - the name of a field or JavaBean property (accessed via getter or setter) on class T ideally annotated with @GeospatialPathIndexProperty

Returns:

the geospatial path range query

range

StructuredQueryDefinition range(java.lang.String pojoProperty,
                                PojoQueryBuilder.Operator operator,
                                java.lang.Object... values)

Query a Path Range Index configured in the database for a pojo property. Make sure the datatype for your values parameter match the datatype configured. For help creating this index, see GenerateIndexConfig and PathIndexProperty.

Parameters:

pojoProperty - the name of a field or JavaBean property (accessed via getter or setter) on class T annotated with @PathIndexProperty

operator - the operator used to compare property values with passed values

values - the possible datatyped values for the comparison. Make sure the datatypes match the datatype configured.

Returns:

the range query

range

StructuredQueryDefinition range(java.lang.String pojoProperty,
                                java.lang.String[] options,
                                PojoQueryBuilder.Operator operator,
                                java.lang.Object... values)

Query a Path Range Index configured in the database for a pojo property. Make sure the datatype for your values parameter match the datatype configured. For help creating this index, see GenerateIndexConfig and PathIndexProperty.

Parameters:

pojoProperty - the name of a field or JavaBean property (accessed via getter or setter) on class T annotated with @PathIndexProperty

options - options for fine tuning the query

operator - the operator used to compare property values with passed values

values - the possible datatyped values for the comparison. Make sure the datatypes match the datatype configured.

Returns:

the range query

value

StructuredQueryDefinition value(java.lang.String pojoProperty,
                                java.lang.String... values)

Filter search results by properties matching specified values.

Parameters:

pojoProperty - the name of a field or JavaBean property (accessed via getter or setter) on class T

values - match a persisted pojo of type T if it has the property with any of the values

Returns:

the value query

value

StructuredQueryDefinition value(java.lang.String pojoProperty,
                                java.lang.Boolean value)

Filter search results by properties matching specified value.

Parameters:

pojoProperty - the name of a field or JavaBean property (accessed via getter or setter) on class T

value - match a persisted pojo of type T if it has the property with the boolean value

Returns:

the value query

value

StructuredQueryDefinition value(java.lang.String pojoProperty,
                                java.lang.Number... values)

Filter search results by properties matching specified values.

Parameters:

pojoProperty - the name of a field or JavaBean property (accessed via getter or setter) on class T

values - match a persisted pojo of type T if it has the property with any of the numeric values

Returns:

the value query

value

StructuredQueryDefinition value(java.lang.String pojoProperty,
                                java.lang.String[] options,
                                double weight,
                                java.lang.String... values)

Filter search results by properties matching specified values.

Parameters:

pojoProperty - the name of a field or JavaBean property (accessed via getter or setter) on class T

options - options for fine tuning the query

weight - the multiplier for the match in the document ranking

values - match a persisted pojo of type T if it has the property with any of the values

Returns:

the value query

value

StructuredQueryDefinition value(java.lang.String pojoProperty,
                                java.lang.String[] options,
                                double weight,
                                java.lang.Boolean value)

Filter search results by properties matching specified values.

Parameters:

pojoProperty - the name of a field or JavaBean property (accessed via getter or setter) on class T

options - options for fine tuning the query

weight - the multiplier for the match in the document ranking

value - match a persisted pojo of type T if it has the property with the boolean value

Returns:

the value query

value

StructuredQueryDefinition value(java.lang.String pojoProperty,
                                java.lang.String[] options,
                                double weight,
                                java.lang.Number... values)

Filter search results by properties matching specified values.

Parameters:

pojoProperty - the name of a field or JavaBean property (accessed via getter or setter) on class T

options - options for fine tuning the query

weight - the multiplier for the match in the document ranking

values - match a persisted pojo of type T if it has the property with any of the numeric values

Returns:

the value query

word

StructuredQueryDefinition word(java.lang.String pojoProperty,
                               java.lang.String... words)

Filter search results by properties with at least one of the specified words or phrases.

Parameters:

pojoProperty - the name of a field or JavaBean property (accessed via getter or setter) on class T

words - match a persisted pojo of type T if it has the property with any of the words or phrases

Returns:

the word query

word

StructuredQueryDefinition word(java.lang.String pojoProperty,
                               java.lang.String[] options,
                               double weight,
                               java.lang.String... words)

Filter search results by properties with at least one of the specified words or phrases.

Parameters:

pojoProperty - the name of a field or JavaBean property (accessed via getter or setter) on class T

options - options for fine tuning the query

weight - the multiplier for the match in the document ranking

words - match a persisted pojo of type T if it has the property with any of the words or phrases

Returns:

the word query

and

StructuredQueryDefinition and(StructuredQueryDefinition... queries)

Copied directly from StructuredQuerybuilder.and. Defines an AND query over the list of query definitions.

Parameters:

queries - the query definitions

Returns:

the StructuredQueryDefinition for the AND query

andNot

StructuredQueryDefinition andNot(StructuredQueryDefinition positive,
                                 StructuredQueryDefinition negative)

Copied directly from StructuredQuerybuilder.andNot. Defines an AND NOT query combining a positive and negative query. You can use an AND or OR query over a list of query definitions as the positive or negative query.

Parameters:

positive - the positive query definition

negative - the negative query definition

Returns:

the StructuredQueryDefinition for the AND NOT query

boost

StructuredQueryDefinition boost(StructuredQueryDefinition matchingQuery,
                                StructuredQueryDefinition boostingQuery)

Copied directly from StructuredQuerybuilder.boost. Defines a boost query for the matching and boosting query definitions. The matching or boosting query definitions can each be an AND or OR query definition for complex combinations of criteria.

Parameters:

matchingQuery - the query definition that filters documents

boostingQuery - the query definition that increases the rank for some filtered documents

Returns:

the StructuredQueryDefinition for the boost query

box

StructuredQueryBuilder.Region box(double south,
                                  double west,
                                  double north,
                                  double east)

Copied directly from StructuredQuerybuilder.box. Specifies a geospatial region as a box, supplying the coordinates for the perimeter.

Parameters:

south - the latitude of the south coordinate

west - the longitude of the west coordinate

north - the latitude of the north coordinate

east - the longitude of the east coordinate

Returns:

the definition of the box

build

RawStructuredQueryDefinition build(StructuredQueryDefinition... queries)

Copied directly from StructuredQuerybuilder.build. Builds a structured query in XML from the list of query definitions. The structured query can be passed to the search() method of QueryManager.

Parameters:

queries - the query definitions

Returns:

the structured query

circle

StructuredQueryBuilder.Region circle(double latitude,
                                     double longitude,
                                     double radius)

Copied directly from StructuredQuerybuilder.circle(double, double, double). Specifies a geospatial region as a circle, supplying coordinates for the center.

Parameters:

latitude - the latitude coordinate of the center

longitude - the longitude coordinate of the center

radius - the radius of the circle

Returns:

the definition of the circle

circle

StructuredQueryBuilder.Region circle(StructuredQueryBuilder.Point center,
                                     double radius)

Copied directly from StructuredQuerybuilder.circle(StructuredQueryBuilder.Point, double). Specifies a geospatial region as a circle, supplying a point for the center.

Parameters:

center - the point defining the center

radius - the radius of the circle

Returns:

the definition of the circle

collection

StructuredQueryDefinition collection(java.lang.String... uris)

Copied directly from StructuredQuerybuilder.collection(String...). Matches documents belonging to at least one of the criteria collections.

Parameters:

uris - the identifiers for the criteria collections

Returns:

the StructuredQueryDefinition for the collection query

geospatial

StructuredQueryDefinition geospatial(StructuredQueryBuilder.GeospatialIndex index,
                                     java.lang.String[] options,
                                     StructuredQueryBuilder.Region... regions)

Copied from StructuredQuerybuilder.geospatial(StructuredQueryBuilder.GeospatialIndex, StructuredQueryBuilder.FragmentScope, String[], StructuredQueryBuilder.Region...) but without StructuredQueryBuilder.FragmentScope. Matches an element, element pair, element attribute, pair, or path specifying a geospatial point that appears within one of the criteria regions.

Parameters:

index - the container for the coordinates of the geospatial point

options - options for fine tuning the query

regions - the possible regions containing the point

Returns:

the StructuredQueryDefinition for the geospatial query

geospatial

StructuredQueryDefinition geospatial(StructuredQueryBuilder.GeospatialIndex index,
                                     StructuredQueryBuilder.Region... regions)

Copied directly from StructuredQuerybuilder.geospatial(StructuredQueryBuilder.GeospatialIndex, StructuredQueryBuilder.Region...). Matches an element, element pair, element attribute, pair, or path specifying a geospatial point that appears within one of the criteria regions.

Parameters:

index - the container for the coordinates of the geospatial point

regions - the possible regions containing the point

Returns:

the StructuredQueryDefinition for the geospatial query

near

StructuredQueryDefinition near(int distance,
                               double weight,
                               StructuredQueryBuilder.Ordering order,
                               StructuredQueryDefinition... queries)

Copied directly from StructuredQuerybuilder.near(int, double, StructuredQueryBuilder.Ordering, StructuredQueryDefinition...). Defines a NEAR query over the list of query definitions with specified parameters.

Parameters:

distance - the proximity for the query terms

weight - the weight for the query

order - the ordering for the query terms

queries - the query definitions

Returns:

the StructuredQueryDefinition for the NEAR query

near

StructuredQueryDefinition near(StructuredQueryDefinition... queries)

Copied directly from StructuredQuerybuilder.near(StructuredQueryDefinition...). Defines a NEAR query over the list of query definitions with default parameters.

Parameters:

queries - the query definitions

Returns:

the StructuredQueryDefinition for the NEAR query

not

StructuredQueryDefinition not(StructuredQueryDefinition query)

Copied directly from StructuredQuerybuilder.not. Defines a NOT query for a query definition. To negate a list of query definitions, define an AND or OR query over the list and define the NOT query over the AND or OR query.

Parameters:

query - the query definition

Returns:

the StructuredQueryDefinition for the NOT query

notIn

StructuredQueryDefinition notIn(StructuredQueryDefinition positive,
                                StructuredQueryDefinition negative)

Copied directly from StructuredQuerybuilder.and. Defines a not-in query for the positive and negative query definitions. These query definitions can each be an AND or OR query definition for complex combinations of criteria.

Parameters:

positive - the query definition that includes documents

negative - the query definition that excludes documents

Returns:

the StructuredQueryDefinition for the not-in query

or

StructuredQueryDefinition or(StructuredQueryDefinition... queries)

Copied directly from StructuredQuerybuilder.and. Defines an OR query over the list of query definitions.

Parameters:

queries - the query definitions

Returns:

the StructuredQueryDefinition for the OR query

point

StructuredQueryBuilder.Region point(double latitude,
                                    double longitude)

Copied directly from StructuredQuerybuilder.point. Specifies a geospatial point.

Parameters:

latitude - the latitude coordinate

longitude - the longitude coordinate

Returns:

the definition of the point

polygon

StructuredQueryBuilder.Region polygon(StructuredQueryBuilder.Point... points)

Copied directly from StructuredQuerybuilder.polygon. Specifies a geospatial region as an arbitrary polygon.

Parameters:

points - the list of points defining the perimeter of the region

Returns:

the definition of the polygon

term

StructuredQueryDefinition term(double weight,
                               java.lang.String... terms)

Copied directly from StructuredQuerybuilder.term(double, String...). Matches documents containing the specified terms, modifying the contribution of the match to the score with the weight.

Parameters:

weight - the multiplier for the match in the document ranking

terms - the possible terms to match

Returns:

the StructuredQueryDefinition for the term query

term

StructuredQueryDefinition term(java.lang.String... terms)

Copied directly from StructuredQuerybuilder.term(String...). Matches documents containing the specified terms.

Parameters:

terms - the possible terms to match

Returns:

the StructuredQueryDefinition for the term query

filteredQuery

PojoQueryDefinition filteredQuery(StructuredQueryDefinition query)

Wraps the structured query into a combined query with options containing <search-option>filtered</search-option> so results are accurate though slower.

Parameters:

query - the query to mark as filtered

Returns:

a QueryDefinition that can be used with PojoRepository.search() (a REST combined query under the hood)