is.codion.framework.model.EntitySearchModel Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of codion-framework-model Show documentation
Show all versions of codion-framework-model Show documentation
Codion Application Framework
/*
* This file is part of Codion.
*
* Codion is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Codion is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Codion. If not, see
* Value type: Integer
* Default value: null
*/
PropertyValue DEFAULT_LIMIT = Configuration.integerValue(EntitySearchModel.class.getName() + ".defaultLimit");
/**
* @return the type of the entity this search model is based on
*/
EntityType entityType();
/**
* @return the connection provider used by this search model
*/
EntityConnectionProvider connectionProvider();
/**
* @return a Value controlling the selected entity
*/
Value entity();
/**
* @return a Value controlling the selected entities
*/
ValueSet entities();
/**
* @return a string describing this search model, by default a comma separated list of search column names
*/
String description();
/**
* @return the columns used when performing a search
*/
Collection> columns();
/**
* Resets the search string so that is represents the selected entities
*/
void reset();
/**
* @return the value controlling the search result limit
*/
Value limit();
/**
* Performs a query based on the current search configuration and returns the result.
* Note that the number of search results may be limited via {@link #limit()}.
* @return a list containing the entities fulfilling the current condition
* @throws IllegalStateException in case no search columns are specified
* @see #limit()
*/
List search();
/**
* Sets the additional search condition supplier to use when performing the next search.
* This condition is AND'ed to the actual search condition.
* NOTE, this does not affect the currently selected value(s), if any.
* @return the Value controlling the additional condition supplier
*/
Value> condition();
/**
* Note that changing this value does not change the search string accordingly.
* @return the Value controlling the function providing the {@code toString()} implementation
* for the entities displayed by this model
* @see #reset()
*/
Value> stringFunction();
/**
* @return a StateObserver indicating whether the search string represents the selected entities
*/
StateObserver searchStringModified();
/**
* @return a StateObserver indicating whether the selection is empty
*/
StateObserver selectionEmpty();
/**
* @return the settings associated with each search column
*/
Map, Settings> settings();
/**
* @return the Value representing the search string
*/
Value searchString();
/**
* @return the Value representing the text used to separate multiple entities
*/
Value separator();
/**
* @return true if single selection is enabled
*/
boolean singleSelection();
/**
* Column search settings
*/
interface Settings {
/**
* @return a State representing whether a wildcard is automatically prepended to the search string
*/
State wildcardPrefix();
/**
* @return a State representing whether a wildcard is automatically appended to the search string
*/
State wildcardPostfix();
/**
* @return a State representing whether spaces in the search string are automatically replaced with wildcards
*/
State spaceAsWildcard();
/**
* @return a State representing whether the search is case-sensitive
*/
State caseSensitive();
}
/**
* A builder for a {@link EntitySearchModel}.
*/
interface Builder {
/**
* @param columns the columns to search by
* @return this builder
* @throws IllegalArgumentException in case {@code columns} is empty
*/
Builder columns(Collection> columns);
/**
* Override the default toString() for search elements when displayed in a field based on this model
* @param stringFunction the function providing the toString() functionality
* @return this builder
*/
Builder stringFunction(Function stringFunction);
/**
* @param description the description
* @return this builder
*/
Builder description(String description);
/**
* Default false
* @param singleSelection true if single selection should be enabled
* @return this builder
*/
Builder singleSelection(boolean singleSelection);
/**
* Default ','
* @param multipleItemSeparator the text used to separate multiple selected items
* @return this builder
*/
Builder separator(String multipleItemSeparator);
/**
* @param limit the search result limit
* @return this builder
*/
Builder limit(int limit);
/**
* @return a new {@link EntitySearchModel} based on this builder
*/
EntitySearchModel build();
}
/**
* Instantiates a new {@link EntitySearchModel.Builder}, initialized with the search columns for the given entity type
* @param entityType the type of the entity to search
* @param connectionProvider the EntityConnectionProvider to use when performing the search
* @return a new {@link EntitySearchModel.Builder} instance
* @see is.codion.framework.domain.entity.EntityDefinition.Columns#searchable()
*/
static EntitySearchModel.Builder builder(EntityType entityType, EntityConnectionProvider connectionProvider) {
return new DefaultEntitySearchModel.DefaultBuilder(entityType, connectionProvider);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy