tpalfy commented on a change in pull request #4123: NIFI-7188: Adding filter capabilities into search & prerequisite refactors URL: https://github.com/apache/nifi/pull/4123#discussion_r393204945
########## File path: nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/search/query/SearchQuery.java ########## @@ -0,0 +1,72 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.nifi.web.search.query; + +import org.apache.nifi.authorization.user.NiFiUser; +import org.apache.nifi.groups.ProcessGroup; + +/** + * Represents the data set the search query executes based on. + */ +public interface SearchQuery { + + /** + * The part of the query string not containing metadata (filters). + * + * @return The query string used for executing the search. + */ + String getTerm(); + + /** + * Returns if the query contains a given filter (regardless the value). + * + * @param filterName The name of the filter. + * + * @return True if the query contains the filter, false otherwise. + */ + boolean hasFilter(String filterName); + + /** + * Returns the value of the query filter. Should be checked with {@link #hasFilter} beforehand! + * + * @param filterName The name of the filter. + * + * @return The value of the filter if exists, otherwise it's null. + */ + String getFilter(String filterName); + + /** + * Returns the user who executes the query. + * + * @return Requesting user. + */ + NiFiUser getUser(); + + /** + * Reference to the flow's root process group. + * + * @return Root group of the flow. + */ + ProcessGroup getRootGroup(); + + /** + * Reference to the process group was active for the user during requesting the search. This might be the same as the root group. Review comment: Reference to the process group _which_ was active... ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
