Interface StructuredQueryDefinition

All Superinterfaces:

PojoQueryDefinition, QueryDefinition, SearchQueryDefinition, ValueQueryDefinition

All Known Subinterfaces:

StructuredQueryBuilder.Box, StructuredQueryBuilder.Circle, StructuredQueryBuilder.Point, StructuredQueryBuilder.Polygon, StructuredQueryBuilder.Region

All Known Implementing Classes:

StructuredQueryBuilder.AbstractStructuredQuery, StructuredQueryBuilder.AndNotQuery, StructuredQueryBuilder.AndQuery, StructuredQueryBuilder.BoxImpl, StructuredQueryBuilder.CircleImpl, 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.PointImpl, StructuredQueryBuilder.PolygonImpl, 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

• Method Summary

  All MethodsInstance MethodsAbstract Methods

  Modifier and Type

  Method

  Description

  String

  getCriteria()

  Returns the query criteria, that is the query string.

  String

  serialize()

  Returns the structured query definition as a serialized XML string.

  void

  serialize(XMLStreamWriter xmlStreamWriter)

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

  void

  setCriteria(String criteria)

  Sets the query criteria as a query string.

  StructuredQueryDefinition

  withCriteria(String criteria)

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

  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

• Method Details

  • serialize

    String serialize()
    Returns the structured query definition as a serialized XML string.

    Returns:

    The serialized definition.

  • serialize

    void serialize(XMLStreamWriter xmlStreamWriter) throws XMLStreamException
    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");.

    Parameters:

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

    Throws:

    XMLStreamException

    Since:

    6.2.0

  • getCriteria

    String getCriteria()
    Returns the query criteria, that is the query string.

    Returns:

    The query string.

  • setCriteria

    void setCriteria(String criteria)
    Sets the query criteria as a query string.

    Parameters:

    criteria - The query string.

  • withCriteria

    StructuredQueryDefinition withCriteria(String criteria)
    Sets the query criteria as a query string and returns the query definition as a fluent convenience.

    Parameters:

    criteria - The query string.

    Returns:

    This query definition.

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