Class StructuredQueryBuilder.AbstractStructuredQuery

All Implemented Interfaces:

PojoQueryDefinition, QueryDefinition, SearchQueryDefinition, StructuredQueryDefinition, ValueQueryDefinition

Direct Known Subclasses:

StructuredQueryBuilder.AndNotQuery, StructuredQueryBuilder.AndQuery, StructuredQueryBuilder.CollectionConstraintQuery, StructuredQueryBuilder.CollectionQuery, StructuredQueryBuilder.ContainerQuery, StructuredQueryBuilder.CustomConstraintQuery, StructuredQueryBuilder.DirectoryQuery, StructuredQueryBuilder.DocumentFragmentQuery, StructuredQueryBuilder.DocumentQuery, StructuredQueryBuilder.FalseQuery, StructuredQueryBuilder.GeospatialConstraintQuery, StructuredQueryBuilder.GeospatialPointQuery, StructuredQueryBuilder.GeospatialRegionConstraintQuery, StructuredQueryBuilder.GeospatialRegionQuery, StructuredQueryBuilder.LocksQuery, StructuredQueryBuilder.NearQuery, StructuredQueryBuilder.NotQuery, StructuredQueryBuilder.OperatorState, StructuredQueryBuilder.OrQuery, StructuredQueryBuilder.PropertiesConstraintQuery, StructuredQueryBuilder.PropertiesQuery, StructuredQueryBuilder.RangeConstraintQuery, StructuredQueryBuilder.RangeQuery, StructuredQueryBuilder.RegionImpl, StructuredQueryBuilder.TemporalLsqtQuery, StructuredQueryBuilder.TemporalPeriod, StructuredQueryBuilder.TemporalPeriodCompareQuery, StructuredQueryBuilder.TemporalPeriodRangeQuery, StructuredQueryBuilder.TermQuery, StructuredQueryBuilder.TimeQuery, StructuredQueryBuilder.TrueQuery, StructuredQueryBuilder.ValueConstraintQuery, StructuredQueryBuilder.ValueQuery, StructuredQueryBuilder.WordConstraintQuery, StructuredQueryBuilder.WordQuery

Enclosing class:

StructuredQueryBuilder

• Field Summary

  Fields inherited from class com.marklogic.client.impl.AbstractSearchQueryDefinition

  optionsUri

• Constructor Summary

  Constructors
  Constructor

  Description

  AbstractStructuredQuery()

   

• Method Summary

  All MethodsInstance MethodsAbstract MethodsConcrete Methods

  Modifier and Type

  Method

  Description

  boolean

  canSerializeQueryAsJSON()

   

  String

  getCriteria()

  Returns the query criteria, that is the query string.

  abstract void

  innerSerialize(XMLStreamWriter serializer)

   

  String

  serialize()

  Returns the structured query definition as a serialized XML string.

  void

  serialize(XMLStreamWriter serializer)

  Serializes the structured query definition to the given XML stream writer.

  void

  setCriteria(String criteria)

  Sets the query criteria as a query string.

  StructuredQueryBuilder.AbstractStructuredQuery

  withCriteria(String criteria)

  Sets the query criteria as a query string and returns the query definition as a fluent convenience.

  Methods inherited from class com.marklogic.client.impl.AbstractQueryDefinition

  getCollections, getDirectory, setCollections, setDirectory

  Methods inherited from class com.marklogic.client.impl.AbstractSearchQueryDefinition

  getOptionsName, getResponseTransform, setOptionsName, setResponseTransform

  Methods inherited from class java.lang.Object

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

  Methods inherited from interface com.marklogic.client.query.QueryDefinition

  getCollections, getDirectory, setCollections, setDirectory

  Methods inherited from interface com.marklogic.client.query.SearchQueryDefinition

  getOptionsName, getResponseTransform, setOptionsName, setResponseTransform

• Constructor Details

  • AbstractStructuredQuery

    public AbstractStructuredQuery()

• Method Details

  • getCriteria

    public String getCriteria()
    Description copied from interface: StructuredQueryDefinition
    Returns the query criteria, that is the query string.

    Specified by:

    getCriteria in interface StructuredQueryDefinition

    Returns:

    The query string.

  • setCriteria

    public void setCriteria(String criteria)
    Description copied from interface: StructuredQueryDefinition
    Sets the query criteria as a query string.

    Specified by:

    setCriteria in interface StructuredQueryDefinition

    Parameters:

    criteria - The query string.

  • withCriteria

    public StructuredQueryBuilder.AbstractStructuredQuery withCriteria(String criteria)
    Description copied from interface: StructuredQueryDefinition
    Sets the query criteria as a query string and returns the query definition as a fluent convenience.

    Specified by:

    withCriteria in interface StructuredQueryDefinition

    Parameters:

    criteria - The query string.

    Returns:

    This query definition.

  • serialize

    public void serialize(XMLStreamWriter serializer) throws XMLStreamException
    Description copied from interface: StructuredQueryDefinition
    Serializes the structured query definition to the given XML stream writer. To ensure that the query elements are written to the correct namespace, you must set the XMLOutputFactory.IS_REPAIRING_NAMESPACES property on the XMLOutputFactory to "true". You may also wish to specify a prefix for the MarkLogic search namespace; you may do so via e.g. xmlStreamWriter.setPrefix("search", "http://marklogic.com/appservices/search");.

    Specified by:

    serialize in interface StructuredQueryDefinition

    Parameters:

    serializer - The XML stream writer to which the query definition should be serialized.

    Throws:

    XMLStreamException

  • serialize

    public String serialize()
    Description copied from interface: StructuredQueryDefinition
    Returns the structured query definition as a serialized XML string.

    Specified by:

    serialize in interface StructuredQueryDefinition

    Returns:

    The serialized definition.

  • innerSerialize

    public abstract void innerSerialize(XMLStreamWriter serializer) throws XMLStreamException

    Throws:

    XMLStreamException

  • canSerializeQueryAsJSON

    public boolean canSerializeQueryAsJSON()

    Specified by:

    canSerializeQueryAsJSON in class com.marklogic.client.impl.AbstractSearchQueryDefinition

Copyright (c) 2010-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.