Deprecated API

Contents

• Deprecated Interfaces
• Deprecated Classes
• Deprecated Methods
• Deprecated Constructors
• Deprecated Enum Constants

Deprecated Interfaces

Interface and Description
com.marklogic.client.query.ElementLocator Use Query By Example instead for easy-to-write and much more full-featured key/value search. An Element Locator specifies an element or element and attribute containing a value as part of a KeyValueQueryDefinition. The element is required. The attribute is optional.
com.marklogic.client.query.KeyLocator Use Query By Example instead for easy-to-write and much more full-featured key/value search. A Key Locator specifies a JSON key containing a value as part of a KeyValueQueryDefinition.
com.marklogic.client.query.KeyValueQueryDefinition Use Query By Example instead for easy-to-write and much more full-featured key/value search. For instance: QueryManager queryMgr = databaseClient.newQueryManager(); String rawXMLQuery = "{ \"$query\": { \"author\": \"Mark Twain\" } }"; StringHandle qbeHandle = new StringHandle(rawXMLQuery).withFormat(Format.JSON); RawQueryByExampleDefinition query = queryMgr.newRawQueryByExampleDefinition(qbeHandle, "myoptions"); SearchHandle resultsHandle = queryMgr.search(query, new SearchHandle());
com.marklogic.client.query.ValueLocator Use Query By Example instead for easy-to-write and much more full-featured key/value search. A Locator identifying a JSON key, element, or element and attribute containing a value as part of a KeyValueQueryDefinition.

Deprecated Classes

Class and Description
com.marklogic.client.admin.config.QueryOptions Use a JSON or XML write handle or read handle implementation instead of this class to write or read query options. For instance: String opts = new StringBuilder() .append("<options xmlns=\"http://marklogic.com/appservices/search\">") .append( "<debug>true</debug>") .append("</options>") .toString(); optsMgr.writeOptions("debug", new StringHandle(opts)); or String opts = "{\"options\":{\"debug\":true}}"; optsMgr.writeOptions("debug", new StringHandle(opts).withFormat(Format.JSON));
com.marklogic.client.admin.config.QueryOptionsBuilder Use a JSON or XML write handle or read handle implementation instead of this class to write or read query options. For instance: String opts = new StringBuilder() .append("<options xmlns=\"http://marklogic.com/appservices/search\">") .append( "<debug>true</debug>") .append("</options>") .toString(); optsMgr.writeOptions("debug", new StringHandle(opts)); or String opts = "{\"options\":{\"debug\":true}}"; optsMgr.writeOptions("debug", new StringHandle(opts).withFormat(Format.JSON));
com.marklogic.client.io.QueryOptionsHandle Use a JSON or XML write handle or read handle implementation instead of this class to write or read query options. For instance: String opts = new StringBuilder() .append("<options xmlns=\"http://marklogic.com/appservices/search\">") .append( "<debug>true</debug>") .append("</options>") .toString(); optsMgr.writeOptions("debug", new StringHandle(opts)); or String opts = "{\"options\":{\"debug\":true}}"; optsMgr.writeOptions("debug", new StringHandle(opts).withFormat(Format.JSON));
com.marklogic.client.query.StructuredQueryBuilder.AndNotQuery Use the StructuredQueryDefinition interface as the type for instances of AndNotQuery.
com.marklogic.client.query.StructuredQueryBuilder.AndQuery Use the StructuredQueryDefinition interface as the type for instances of AndQuery.
com.marklogic.client.query.StructuredQueryBuilder.Box Use the Region interface as the type for instances of Box.
com.marklogic.client.query.StructuredQueryBuilder.Circle Use the Region interface as the type for instances of Circle.
com.marklogic.client.query.StructuredQueryBuilder.CollectionConstraintQuery Use the StructuredQueryDefinition interface as the type for instances of CollectionConstraintQuery.
com.marklogic.client.query.StructuredQueryBuilder.CollectionQuery Use the StructuredQueryDefinition interface as the type for instances of CollectionQuery.
com.marklogic.client.query.StructuredQueryBuilder.CustomConstraintQuery Use the StructuredQueryDefinition interface as the type for instances of CustomConstraintQuery.
com.marklogic.client.query.StructuredQueryBuilder.DirectoryQuery Use the StructuredQueryDefinition interface as the type for instances of DirectoryQuery.
com.marklogic.client.query.StructuredQueryBuilder.DocumentFragmentQuery Use the StructuredQueryDefinition interface as the type for instances of DocumentFragmentQuery.
com.marklogic.client.query.StructuredQueryBuilder.DocumentQuery Use the StructuredQueryDefinition interface as the type for instances of DocumentQuery.
com.marklogic.client.query.StructuredQueryBuilder.ElementConstraintQuery Use the StructuredQueryDefinition interface as the type for instances of ElementConstraintQuery.
com.marklogic.client.query.StructuredQueryBuilder.GeospatialConstraintQuery Use the StructuredQueryDefinition interface as the type for instances of GeospatialConstraintQuery.
com.marklogic.client.query.StructuredQueryBuilder.LocksQuery Use the StructuredQueryDefinition interface as the type for instances of LocksQuery.
com.marklogic.client.query.StructuredQueryBuilder.NearQuery Use the StructuredQueryDefinition interface as the type for instances of NearQuery.
com.marklogic.client.query.StructuredQueryBuilder.NotQuery Use the StructuredQueryDefinition interface as the type for instances of NotQuery.
com.marklogic.client.query.StructuredQueryBuilder.OrQuery Use the StructuredQueryDefinition interface as the type for instances of OrQuery.
com.marklogic.client.query.StructuredQueryBuilder.Point Treat the Point class as an interface that extends Region.
com.marklogic.client.query.StructuredQueryBuilder.Polygon Use the Region interface as the type for instances of Polygon.
com.marklogic.client.query.StructuredQueryBuilder.PropertiesConstraintQuery Use the StructuredQueryDefinition interface as the type for instances of PropertiesConstraintQuery.
com.marklogic.client.query.StructuredQueryBuilder.PropertiesQuery Use the StructuredQueryDefinition interface as the type for instances of PropertiesQuery.
com.marklogic.client.query.StructuredQueryBuilder.RangeConstraintQuery Use the StructuredQueryDefinition interface as the type for instances of RangeConstraintQuery.
com.marklogic.client.query.StructuredQueryBuilder.TermQuery Use the StructuredQueryDefinition interface as the type for instances of TermQuery.
com.marklogic.client.query.StructuredQueryBuilder.ValueConstraintQuery Use the StructuredQueryDefinition interface as the type for instances of ValueConstraintQuery.
com.marklogic.client.query.StructuredQueryBuilder.WordConstraintQuery Use the StructuredQueryDefinition interface as the type for instances of WordConstraintQuery.

Deprecated Methods

Method and Description
com.marklogic.client.query.StructuredQueryBuilder.elementConstraint(String, StructuredQueryDefinition) Matches a query within the substructure of the container specified by the constraint. This method is deprecated in favor of the more general containerConstraint() method.
com.marklogic.client.admin.ServerConfigurationManager.getContentVersionRequests() use ServerConfigurationManager.getUpdatePolicy(), which provides more alternatives
com.marklogic.client.document.JSONDocumentManager.getLanguage() as a result of adding native json support, the lang param in the REST API is deprecated
com.marklogic.client.query.StructuredQueryBuilder.Point.getLatitude()
com.marklogic.client.query.StructuredQueryBuilder.Point.getLongitude()
com.marklogic.client.query.SearchMetrics.getMetadataResolutionTime()
com.marklogic.client.query.QueryManager.newElementLocator(QName) Use Query By Example instead for easy-to-write and much more full-featured key/value search. Creates a locator for a key-value query based on an element name, which may have namespace.
com.marklogic.client.query.QueryManager.newElementLocator(QName, QName) Use Query By Example instead for easy-to-write and much more full-featured key/value search. Creates a locator for a key-value query based on an element name and attribute name, either or both of which may have a namespace.
com.marklogic.client.query.QueryManager.newKeyLocator(String) Use Query By Example instead for easy-to-write and much more full-featured key/value search. Creates a locator for a key-value query based on a JSON key.
com.marklogic.client.query.QueryManager.newKeyValueDefinition() Use Query By Example instead for easy-to-write and much more full-featured key/value search. Creates a query definition based on a locator such as a JSON property, element name, or element and attribute name and the default query options.
com.marklogic.client.query.QueryManager.newKeyValueDefinition(String) Use Query By Example instead for easy-to-write and much more full-featured key/value search. Creates a query definition based on a locator and on named query options saved previously.
com.marklogic.client.query.StructuredQueryBuilder.Region.serialize() Returns the region as a partial string. This method will be removed in a future release.
com.marklogic.client.admin.ServerConfigurationManager.setContentVersionRequests(ServerConfigurationManager.Policy) use ServerConfigurationManager.setUpdatePolicy(UpdatePolicy), which provides more alternatives
com.marklogic.client.io.SearchHandle.setForceDOM(boolean)
com.marklogic.client.document.JSONDocumentManager.setLanguage(String) as a result of adding native json support, the lang param in the REST API is deprecated
com.marklogic.client.admin.TransformExtensionsManager.writeXQueryTransform(String, TextWriteHandle, ExtensionMetadata, Map<String, String>)
com.marklogic.client.admin.TransformExtensionsManager.writeXSLTransform(String, XMLWriteHandle, ExtensionMetadata, Map<String, String>)

Deprecated Constructors

Constructor and Description
com.marklogic.client.query.StructuredQueryBuilder.AndNotQuery(StructuredQueryDefinition, StructuredQueryDefinition) Use the andNot() builder method of StructuredQueryBuilder and type the object as an instance of the StructuredQueryDefinition interface.
com.marklogic.client.query.StructuredQueryBuilder.AndQuery(StructuredQueryDefinition...) Use the and() builder method of StructuredQueryBuilder and type the object as an instance of the StructuredQueryDefinition interface.
com.marklogic.client.query.StructuredQueryBuilder.Box(double, double, double, double) Use the box() builder method of StructuredQueryBuilder and type the object as an instance of the Region interface.
com.marklogic.client.query.StructuredQueryBuilder.Circle(double, double, double) Use the circle() builder method of StructuredQueryBuilder and type the object as an instance of the Region interface.
com.marklogic.client.query.StructuredQueryBuilder.CollectionConstraintQuery(String, String...) Use the collectionConstraint() builder method of StructuredQueryBuilder and type the object as an instance of the StructuredQueryDefinition interface.
com.marklogic.client.query.StructuredQueryBuilder.CollectionQuery(String...) Use the collection() builder method of StructuredQueryBuilder and type the object as an instance of the StructuredQueryDefinition interface.
com.marklogic.client.query.StructuredQueryBuilder.CustomConstraintQuery(String, String...) Use the customConstraint() builder method of StructuredQueryBuilder and type the object as an instance of the StructuredQueryDefinition interface.
com.marklogic.client.query.StructuredQueryBuilder.DirectoryQuery(Boolean, String...) Use the directory() builder method of StructuredQueryBuilder and type the object as an instance of the StructuredQueryDefinition interface.
com.marklogic.client.query.StructuredQueryBuilder.DocumentFragmentQuery(StructuredQueryDefinition) Use the documentFragment() builder method of StructuredQueryBuilder and type the object as an instance of the StructuredQueryDefinition interface.
com.marklogic.client.query.StructuredQueryBuilder.DocumentQuery(String...) Use the document() builder method of StructuredQueryBuilder and type the object as an instance of the StructuredQueryDefinition interface.
com.marklogic.client.query.StructuredQueryBuilder.ElementConstraintQuery(String, StructuredQueryDefinition) Use the elementConstraint() builder method of StructuredQueryBuilder and type the object as an instance of the StructuredQueryDefinition interface.
com.marklogic.client.query.StructuredQueryBuilder.GeospatialConstraintQuery(String, StructuredQueryBuilder.Region...) Use the geospatialConstraint() builder method of StructuredQueryBuilder and type the object as an instance of the StructuredQueryDefinition interface.
com.marklogic.client.query.StructuredQueryBuilder.LocksQuery(StructuredQueryDefinition) Use the locks() builder method of StructuredQueryBuilder and type the object as an instance of the StructuredQueryDefinition interface.
com.marklogic.client.query.StructuredQueryBuilder.NearQuery(StructuredQueryDefinition...) Use the near() builder method of StructuredQueryBuilder and type the object as an instance of the StructuredQueryDefinition interface.
com.marklogic.client.query.StructuredQueryBuilder.NotQuery(StructuredQueryDefinition) Use the not() builder method of StructuredQueryBuilder and type the object as an instance of the StructuredQueryDefinition interface.
com.marklogic.client.query.StructuredQueryBuilder.OrQuery(StructuredQueryDefinition...) Use the or() builder method of StructuredQueryBuilder and type the object as an instance of the StructuredQueryDefinition interface.
com.marklogic.client.query.StructuredQueryBuilder.Point(double, double) Use the point() builder method of StructuredQueryBuilder.
com.marklogic.client.query.StructuredQueryBuilder.Polygon(StructuredQueryBuilder.Point...) Use the polygon() builder method of StructuredQueryBuilder and type the object as an instance of the Region interface.
com.marklogic.client.query.StructuredQueryBuilder.PropertiesConstraintQuery(String, StructuredQueryDefinition) Use the propertiesConstraint() builder method of StructuredQueryBuilder operator and type the object as an instance of the StructuredQueryDefinition interface.
com.marklogic.client.query.StructuredQueryBuilder.PropertiesQuery(StructuredQueryDefinition) Use the properties() builder method of StructuredQueryBuilder and type the object as an instance of the StructuredQueryDefinition interface.
com.marklogic.client.query.StructuredQueryBuilder.RangeConstraintQuery(String, StructuredQueryBuilder.Operator, String...) Use the rangeConstraint() builder method of StructuredQueryBuilder and type the object as an instance of the StructuredQueryDefinition interface.
com.marklogic.client.query.StructuredQueryBuilder.TermQuery(Double, String...) Use the term() builder method of StructuredQueryBuilder and type the object as an instance of the StructuredQueryDefinition interface.
com.marklogic.client.query.StructuredQueryBuilder.ValueConstraintQuery(String, String...) Use the valueConstraint() builder method of StructuredQueryBuilder and type the object as an instance of the StructuredQueryDefinition interface.
com.marklogic.client.query.StructuredQueryBuilder.WordConstraintQuery(String, String...) Use the wordConstraint() builder method of StructuredQueryBuilder and type the object as an instance of the StructuredQueryDefinition interface.

Deprecated Enum Constants

Enum Constant and Description
com.marklogic.client.query.StructuredQueryBuilder.FragmentScope.DOCUMENT