mirror of
https://github.com/scm-manager/scm-manager.git
synced 2026-01-24 00:09:07 +01:00
Prepare search api for different types (#1732)
We introduced a new annotation '@IndexedType' which gets collected by the scm-annotation-processor. All classes which are annotated are index and searchable. This opens the search api for plugins.
This commit is contained in:
Sebastian Sdorra
GitHub
144
scm-annotations/src/main/java/sonia/scm/search/Indexed.java
Normal file
144
scm-annotations/src/main/java/sonia/scm/search/Indexed.java
Normal file
@@ -0,0 +1,144 @@
|
||||
/*
|
||||
* MIT License
|
||||
*
|
||||
* Copyright (c) 2020-present Cloudogu GmbH and Contributors
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in all
|
||||
* copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
* SOFTWARE.
|
||||
*/
|
||||
|
||||
package sonia.scm.search;
|
||||
|
||||
import com.google.common.annotations.Beta;
|
||||
|
||||
import java.lang.annotation.Documented;
|
||||
import java.lang.annotation.ElementType;
|
||||
import java.lang.annotation.Retention;
|
||||
import java.lang.annotation.RetentionPolicy;
|
||||
import java.lang.annotation.Target;
|
||||
|
||||
/**
|
||||
* Mark a field which should be indexed.
|
||||
* @since 2.21.0
|
||||
*/
|
||||
@Beta
|
||||
@Documented
|
||||
@Target(ElementType.FIELD)
|
||||
@Retention(RetentionPolicy.RUNTIME)
|
||||
public @interface Indexed {
|
||||
|
||||
/**
|
||||
* Name of the field.
|
||||
* If not set the name of the annotated field is used.
|
||||
*
|
||||
* @return name of field
|
||||
*/
|
||||
String name() default "";
|
||||
|
||||
/**
|
||||
* Describes how the field is indexed.
|
||||
*
|
||||
* @return type of indexing
|
||||
*/
|
||||
Type type() default Type.TOKENIZED;
|
||||
|
||||
/**
|
||||
* {@code true} if this field should be part of default query for this type of object.
|
||||
*
|
||||
* @return {@code true} if field is part of default query
|
||||
*/
|
||||
boolean defaultQuery() default false;
|
||||
|
||||
/**
|
||||
* Boost the object if the searched query matches this field.
|
||||
* Greater than one brings the object further up in the search results.
|
||||
* Smaller than one devalues the object in the search results.
|
||||
*
|
||||
* @return boost score
|
||||
*/
|
||||
float boost() default 1f;
|
||||
|
||||
/**
|
||||
* {@code true} to search the field value for matches and returns fragments with those matches instead of the whole value.
|
||||
*
|
||||
* @return {@code true} to return matched fragments
|
||||
*/
|
||||
boolean highlighted() default false;
|
||||
|
||||
/**
|
||||
* Describes how the field is indexed.
|
||||
*/
|
||||
enum Type {
|
||||
/**
|
||||
* The value of the field is analyzed and split into tokens, which allows searches for parts of the value.
|
||||
* Tokenization only works for string values. If a field with another type is marked as tokenized,
|
||||
* the field is indexed as if it was marked as {@link #SEARCHABLE}.
|
||||
*/
|
||||
TOKENIZED(true, true, true),
|
||||
|
||||
/**
|
||||
* The value can only be searched as a whole.
|
||||
* Numeric fields can also be search as part of a range,
|
||||
* but strings are only found if the query contains the whole field value.
|
||||
*/
|
||||
SEARCHABLE(false, true, true),
|
||||
|
||||
/**
|
||||
* Value of the field cannot be searched for, but is returned in the result.
|
||||
*/
|
||||
STORED_ONLY(false, false, true);
|
||||
|
||||
private final boolean tokenized;
|
||||
private final boolean searchable;
|
||||
private final boolean stored;
|
||||
|
||||
Type(boolean tokenized, boolean searchable, boolean stored) {
|
||||
this.tokenized = tokenized;
|
||||
this.searchable = searchable;
|
||||
this.stored = stored;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns {@code true} if the field is tokenized.
|
||||
*
|
||||
* @return {@code true} if tokenized
|
||||
* @see #TOKENIZED
|
||||
*/
|
||||
public boolean isTokenized() {
|
||||
return tokenized;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns {@code true} if the field is searchable.
|
||||
*
|
||||
* @return {@code true} if searchable
|
||||
* @see #SEARCHABLE
|
||||
*/
|
||||
public boolean isSearchable() {
|
||||
return searchable;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns {@code true} if the field is stored.
|
||||
* @return {@code true} if stored
|
||||
*/
|
||||
public boolean isStored() {
|
||||
return stored;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,54 @@
|
||||
/*
|
||||
* MIT License
|
||||
*
|
||||
* Copyright (c) 2020-present Cloudogu GmbH and Contributors
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in all
|
||||
* copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
* SOFTWARE.
|
||||
*/
|
||||
|
||||
package sonia.scm.search;
|
||||
|
||||
import com.google.common.annotations.Beta;
|
||||
import sonia.scm.plugin.PluginAnnotation;
|
||||
|
||||
import java.lang.annotation.Documented;
|
||||
import java.lang.annotation.ElementType;
|
||||
import java.lang.annotation.Retention;
|
||||
import java.lang.annotation.RetentionPolicy;
|
||||
import java.lang.annotation.Target;
|
||||
|
||||
/**
|
||||
* Mark an field object should be indexed.
|
||||
*
|
||||
* @since 2.21.0
|
||||
*/
|
||||
@Beta
|
||||
@Documented
|
||||
@Target(ElementType.TYPE)
|
||||
@Retention(RetentionPolicy.RUNTIME)
|
||||
@PluginAnnotation("indexed-type")
|
||||
public @interface IndexedType {
|
||||
/**
|
||||
* Returns the name of the indexed object.
|
||||
* Default is the simple name of the indexed class, with the first char is lowercase.
|
||||
*
|
||||
* @return name of the index object or an empty string which indicates that the default should be used.
|
||||
*/
|
||||
String value() default "";
|
||||
}
|
||||
Reference in New Issue
Block a user