org.netbeans.modules.parsing.spi.indexing.support

Class QuerySupport.Query.Factory

java.lang.Object

org.netbeans.modules.parsing.spi.indexing.support.QuerySupport.Query.Factory

Enclosing class:

QuerySupport.Query

public static final class QuerySupport.Query.Factory
extends Object

Factory for an index queries.

Method Summary

Modifier and Type	Method and Description
QuerySupport.Query	and(QuerySupport.Query... queries) Creates a boolean AND query.
QuerySupport.Query	field(String fieldName, String fieldValue, QuerySupport.Kind kind) Creates a query for required field value.
QuerySupport.Query	file(FileObject file) Creates a query for documents created for a file.
QuerySupport.Query	file(String relativePath) Creates a query for documents created for a file.
QuerySupport.Query	or(QuerySupport.Query... queries) Creates a boolean OR query.
QuerySupport.Query.Factory	setCamelCasePart(String camelCasePart) Sets a camel case part.
QuerySupport.Query.Factory	setCamelCaseSeparator(String camelCaseSeparator) Sets a camel case separator.

Methods inherited from class java.lang.Object

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

Method Detail

field

@NonNull
public QuerySupport.Query field(@NonNull
                                         String fieldName,
                                         @NonNull
                                         String fieldValue,
                                         @NonNull
                                         QuerySupport.Kind kind)

Creates a query for required field value.

Parameters:

fieldName - the name of the tested field

fieldValue - the required value of the tested field

kind - the kind of the query

Returns:

the newly created query

file

@NonNull
public QuerySupport.Query file(@NonNull
                                        String relativePath)

Creates a query for documents created for a file.

Parameters:

relativePath - the relative path from source root the QuerySupport was created for

Returns:

the newly created query

Since:

1.75

file

@NonNull
public QuerySupport.Query file(@NonNull
                                        FileObject file)

Creates a query for documents created for a file.

Parameters:

file - the file under a source root the QuerySupport was created for

Returns:

the newly created query

Throws:

IllegalArgumentException - if the file is not under the QuerySupport roots

Since:

1.75

and

@NonNull
public QuerySupport.Query and(@NonNull
                                       QuerySupport.Query... queries)

Creates a boolean AND query.

Parameters:

queries - the queries to compose into the AND query

Returns:

the newly created AND query

or

@NonNull
public QuerySupport.Query or(@NonNull
                                      QuerySupport.Query... queries)

Creates a boolean OR query.

Parameters:

queries - the queries to compose into the OR query

Returns:

the newly created OR query

setCamelCaseSeparator

@NonNull
public QuerySupport.Query.Factory setCamelCaseSeparator(@NullAllowed
                                                                 String camelCaseSeparator)

Sets a camel case separator. Sets a regular expression for camel case separator.

Parameters:

camelCaseSeparator - the regular expression for camel case separator. When null the default (upper case letter) is used.

Returns:

the QuerySupport.Query.Factory

Since:

9.5

setCamelCasePart

@NonNull
public QuerySupport.Query.Factory setCamelCasePart(@NullAllowed
                                                            String camelCasePart)

Sets a camel case part. Sets a regular expression for camel case part content.

Parameters:

camelCasePart - the regular expression for camel case part. When null the default (lower case letter, digit) is used.

Returns:

the QuerySupport.Query.Factory

Since:

9.5