1 /*
2 * Copyright 2013-2023 Medical Information Systems Research Group (https://medical.zcu.cz),
3 * Department of Computer Science and Engineering, University of West Bohemia.
4 * Address: Univerzitni 8, 306 14 Plzen, Czech Republic.
5 *
6 * This file is part of Sparkle project.
7 *
8 * Sparkle is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation, either version 3 of the License.
11 *
12 * Sparkle is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with Sparkle. If not, see <http://www.gnu.org/licenses/>.
19 */
20 package cz.zcu.mre.sparkle.gui.query.helpers;
21
22 import cz.zcu.mre.sparkle.tools.Definitions;
23 import java.util.Set;
24
25 /**
26 * Objekty třídy implementující toto rozhraní používají ke svým potřebám prefix.
27 * Použití prefixu v dotazu je podmíněno jeho definicí v hlavičce sestaveného
28 * dotazu. Aplikace proto potřebuje znát, jaké prefixy jsou kde použity, aby je
29 * mohla v hlavičce dotazu uvést.
30 *
31 * @author Jan Smucr
32 * @author Petr Vcelak (vcelak@kiv.zcu.cz)
33 */
34 public interface PrefixesUser {
35
36 /**
37 * Vrací sadu používaných prefixů.
38 *
39 * @param appendDelimiter Pokud je <code>true</code>, měl by každý vrácený
40 * prefix končit na {@value Definitions#PREFIXED_NAME_PREFIX_DELIMITER}.
41 *
42 * @return Sada prefixů.
43 */
44 Set<String> getPrefixesUsed(boolean appendDelimiter);
45 }