DocumentTypeQuery (Ametys 4.4.x - API)

java.lang.Object
- org.ametys.cms.search.query.DocumentTypeQuery

All Implemented Interfaces:: Query

public class DocumentTypeQuery
extends Object
implements Query

A query on the document type.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.ametys.cms.search.query.Query
  Query.LogicalOperator, Query.Operator

Field Summary

Fields
Modifier and Type Field Description

private boolean _positive
false to negate the query.

private String _type
The document type.

Constructor Summary

Constructors
Constructor	Description
`DocumentTypeQuery(String type)`	Build a document type query.
`DocumentTypeQuery(String type, boolean positiveQuery)`	Build a document type query.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`build()`	Build the solr query string representing the Query object.
`boolean`	`equals(Object obj)`
`int`	`hashCode()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.ametys.cms.search.query.Query
toString

- Field Detail
  - _type
```
private String _type
```
    The document type.
  - _positive
```
private boolean _positive
```
    false to negate the query.
- Constructor Detail
  - DocumentTypeQuery
```
public DocumentTypeQuery(String type)
```
    Build a document type query.
    
    Parameters:
    
    type - The document type to test.
  - DocumentTypeQuery
```
public DocumentTypeQuery(String type,
                         boolean positiveQuery)
```
    Build a document type query.
    
    Parameters:
    
    type - The document type to test.
    
    positiveQuery - false to negate the query.
- Method Detail
  - build
```
public String build()
             throws QuerySyntaxException
```
    Description copied from interface: Query
    
    Build the solr query string representing the Query object.
    
    Specified by:
    
    build in interface Query
    
    Returns:
    
    the solr query string representing the Query object.
    
    Throws:
    
    QuerySyntaxException - if the query can't be built because of a syntax error.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object