2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
7 * Jalview is free software: you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation, either version 3
10 * of the License, or (at your option) any later version.
12 * Jalview is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty
14 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15 * PURPOSE. See the GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with Jalview. If not, see <http://www.gnu.org/licenses/>.
19 * The Jalview Authors are detailed in the 'AUTHORS' file.
22 package jalview.fts.api;
25 * This interface provides a model for the dynamic data column configuration
30 public interface FTSDataColumnI
33 * Returns the name of the data column
35 * @return the data column's name
37 public String getName();
40 * Returns the code of the data column
42 * @return the data column's code
44 public String getCode();
47 * Returns the alternative code value for the data column
49 * @return the data column's code
51 public String getAltCode();
54 * Returns the minimum width of the data column
56 * @return the data column's minimum width
58 public int getMinWidth();
61 * Returns the maximum width of the data column
63 * @return the data column's maximum width
65 public int getMaxWidth();
68 * Returns the preferred width of the data column
70 * @return the data column's preferred width
72 public int getPreferredWidth();
75 * Determines if the data column is the primary key column
77 * @return true if data column is the primary key column, otherwise false
79 public boolean isPrimaryKeyColumn();
82 * Checks if the data column field can be used to perform a search query
84 * @return true means the data column is searchable
86 public boolean isSearchable();
89 * Checks if the data column is displayed by default
91 * @return true means the data column is shown by default
93 public boolean isVisibleByDefault();
96 * Returns the data column's FTS data column group
98 * @return the FTSDataColumnGroupI for the column
100 public FTSDataColumnGroupI getGroup();
103 * Returns the data columns data type POJO
105 * @return the DataTypeI for the column
107 public DataTypeI getDataType();
110 * This interface provides a model for the dynamic data column group
113 public interface FTSDataColumnGroupI
116 * Returns the Id of the data column's group
118 * @return the data column's group Id
120 public String getID();
123 * Returns the name of the group
125 * @return the group's name
127 public String getName();
130 * Returns the sort order of the group
132 * @return the group's sort order
134 public int getSortOrder();
137 public interface DataTypeI
140 * Returns the data column's data type class
142 * @return the Class for the data column's data type
144 public Class getDataTypeClass();
147 * Checks if the numeric data column's data will be formated
149 * @return true means the numeric data column shall be formatted
151 public boolean isFormtted();
154 * Returns the number of significant figure to be used for the numeric value
157 * @return the number of significant figures
159 public int getSignificantFigures();