Classes

Class	Line #	Total Statements	Complexity	TOTAL Coverage	Actions
FTSDataColumnI	30	0	0	-1.0 -	Show methods
FTSDataColumnI.FTSDataColumnGroupI	113	0	0	-1.0 -	Show methods
FTSDataColumnI.DataTypeI	137	0	0	-1.0 -	Show methods

Class FTSDataColumnI

Class FTSDataColumnI	Line # 30	Total Statements 0	Complexity 0	TOTAL Coverage -1.0 -

 

Class FTSDataColumnI.FTSDataColumnGroupI

Class FTSDataColumnI.FTSDataColumnGroupI	Line # 113	Total Statements 0	Complexity 0	TOTAL Coverage -1.0 -

 

Class FTSDataColumnI.DataTypeI

Class FTSDataColumnI.DataTypeI	Line # 137	Total Statements 0	Complexity 0	TOTAL Coverage -1.0 -

 

Contributing tests

Source view

1		/*
2		* Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3		* Copyright (C) $$Year-Rel$$ The Jalview Authors
4		*
5		* This file is part of Jalview.
6		*
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.
11		*
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.
16		*
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.
20		*/
21
22		package jalview.fts.api;
23
24		/**
25		* This interface provides a model for the dynamic data column configuration
26		*
27		* @author tcnofoegbu
28		*
29		*/
		- Uncovered Elements: 0 (0) Complexity: 0 Complexity Density: -
30		public interface FTSDataColumnI
31		{
32		/**
33		* Returns the name of the data column
34		*
35		* @return the data column's name
36		*/
37		public String getName();
38
39		/**
40		* Returns the code of the data column
41		*
42		* @return the data column's code
43		*/
44		public String getCode();
45
46		/**
47		* Returns the alternative code value for the data column
48		*
49		* @return the data column's code
50		*/
51		public String getAltCode();
52
53		/**
54		* Returns the minimum width of the data column
55		*
56		* @return the data column's minimum width
57		*/
58		public int getMinWidth();
59
60		/**
61		* Returns the maximum width of the data column
62		*
63		* @return the data column's maximum width
64		*/
65		public int getMaxWidth();
66
67		/**
68		* Returns the preferred width of the data column
69		*
70		* @return the data column's preferred width
71		*/
72		public int getPreferredWidth();
73
74		/**
75		* Determines if the data column is the primary key column
76		*
77		* @return true if data column is the primary key column, otherwise false
78		*/
79		public boolean isPrimaryKeyColumn();
80
81		/**
82		* Checks if the data column field can be used to perform a search query
83		*
84		* @return true means the data column is searchable
85		*/
86		public boolean isSearchable();
87
88		/**
89		* Checks if the data column is displayed by default
90		*
91		* @return true means the data column is shown by default
92		*/
93		public boolean isVisibleByDefault();
94
95		/**
96		* Returns the data column's FTS data column group
97		*
98		* @return the FTSDataColumnGroupI for the column
99		*/
100		public FTSDataColumnGroupI getGroup();
101
102		/**
103		* Returns the data columns data type POJO
104		*
105		* @return the DataTypeI for the column
106		*/
107		public DataTypeI getDataType();
108
109		/**
110		* This interface provides a model for the dynamic data column group
111		*
112		*/
		- Uncovered Elements: 0 (0) Complexity: 0 Complexity Density: -
113		public interface FTSDataColumnGroupI
114		{
115		/**
116		* Returns the Id of the data column's group
117		*
118		* @return the data column's group Id
119		*/
120		public String getID();
121
122		/**
123		* Returns the name of the group
124		*
125		* @return the group's name
126		*/
127		public String getName();
128
129		/**
130		* Returns the sort order of the group
131		*
132		* @return the group's sort order
133		*/
134		public int getSortOrder();
135		}
136
		- Uncovered Elements: 0 (0) Complexity: 0 Complexity Density: -
137		public interface DataTypeI
138		{
139		/**
140		* Returns the data column's data type class
141		*
142		* @return the Class for the data column's data type
143		*/
144		public Class getDataTypeClass();
145
146		/**
147		* Checks if the numeric data column's data will be formated
148		*
149		* @return true means the numeric data column shall be formatted
150		*/
151		public boolean isFormtted();
152
153		/**
154		* Returns the number of significant figure to be used for the numeric value
155		* formatting
156		*
157		* @return the number of significant figures
158		*/
159		public int getSignificantFigures();
160		}
161		}