Mercurial > repos > deepakjadmin > mayatool3_test3
comparison mayachemtools/docs/modules/html/code/FingerprintsFPFileIO.html @ 0:73ae111cf86f draft
Uploaded
author | deepakjadmin |
---|---|
date | Wed, 20 Jan 2016 11:55:01 -0500 |
parents | |
children |
comparison
equal
deleted
inserted
replaced
-1:000000000000 | 0:73ae111cf86f |
---|---|
1 <html> | |
2 <head> | |
3 <title>MayaChemTools:Code:FileIO::FingerprintsFPFileIO.pm</title> | |
4 <meta http-equiv="content-type" content="text/html;charset=utf-8"> | |
5 <link rel="stylesheet" type="text/css" href="../../../css/MayaChemToolsCode.css"> | |
6 </head> | |
7 <body leftmargin="20" rightmargin="20" topmargin="10" bottommargin="10"> | |
8 <br/> | |
9 <center> | |
10 <a href="http://www.mayachemtools.org" title="MayaChemTools Home"><img src="../../../images/MayaChemToolsLogo.gif" border="0" alt="MayaChemTools"></a> | |
11 </center> | |
12 <br/> | |
13 <pre> | |
14 <a name="package-FileIO::FingerprintsFPFileIO-"></a> 1 <span class="k">package </span><span class="i">FileIO::FingerprintsFPFileIO</span><span class="sc">;</span> | |
15 2 <span class="c">#</span> | |
16 3 <span class="c"># $RCSfile: FingerprintsFPFileIO.pm,v $</span> | |
17 4 <span class="c"># $Date: 2015/02/28 20:48:43 $</span> | |
18 5 <span class="c"># $Revision: 1.19 $</span> | |
19 6 <span class="c">#</span> | |
20 7 <span class="c"># Author: Manish Sud <msud@san.rr.com></span> | |
21 8 <span class="c">#</span> | |
22 9 <span class="c"># Copyright (C) 2015 Manish Sud. All rights reserved.</span> | |
23 10 <span class="c">#</span> | |
24 11 <span class="c"># This file is part of MayaChemTools.</span> | |
25 12 <span class="c">#</span> | |
26 13 <span class="c"># MayaChemTools is free software; you can redistribute it and/or modify it under</span> | |
27 14 <span class="c"># the terms of the GNU Lesser General Public License as published by the Free</span> | |
28 15 <span class="c"># Software Foundation; either version 3 of the License, or (at your option) any</span> | |
29 16 <span class="c"># later version.</span> | |
30 17 <span class="c">#</span> | |
31 18 <span class="c"># MayaChemTools is distributed in the hope that it will be useful, but without</span> | |
32 19 <span class="c"># any warranty; without even the implied warranty of merchantability of fitness</span> | |
33 20 <span class="c"># for a particular purpose. See the GNU Lesser General Public License for more</span> | |
34 21 <span class="c"># details.</span> | |
35 22 <span class="c">#</span> | |
36 23 <span class="c"># You should have received a copy of the GNU Lesser General Public License</span> | |
37 24 <span class="c"># along with MayaChemTools; if not, see <http://www.gnu.org/licenses/> or</span> | |
38 25 <span class="c"># write to the Free Software Foundation Inc., 59 Temple Place, Suite 330,</span> | |
39 26 <span class="c"># Boston, MA, 02111-1307, USA.</span> | |
40 27 <span class="c">#</span> | |
41 28 | |
42 29 <span class="k">use</span> <span class="w">strict</span><span class="sc">;</span> | |
43 30 <span class="k">use</span> <span class="w">Carp</span><span class="sc">;</span> | |
44 31 <span class="k">use</span> <span class="w">Exporter</span><span class="sc">;</span> | |
45 32 <span class="k">use</span> <span class="w">Scalar::Util</span> <span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
46 33 <span class="k">use</span> <span class="w">TextUtil</span> <span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
47 34 <span class="k">use</span> <span class="w">FileUtil</span> <span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
48 35 <span class="k">use</span> <span class="w">TimeUtil</span> <span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
49 36 <span class="k">use</span> <span class="w">Fingerprints::FingerprintsStringUtil</span> <span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
50 37 <span class="k">use</span> <span class="w">PackageInfo</span> <span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
51 38 <span class="k">use</span> <span class="w">FileIO::FileIO</span><span class="sc">;</span> | |
52 39 | |
53 40 <span class="k">use</span> <span class="w">vars</span> <span class="q">qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS)</span><span class="sc">;</span> | |
54 41 | |
55 42 <span class="i">@ISA</span> = <span class="q">qw(FileIO::FileIO Exporter)</span><span class="sc">;</span> | |
56 43 <span class="i">@EXPORT</span> = <span class="q">qw()</span><span class="sc">;</span> | |
57 44 <span class="i">@EXPORT_OK</span> = <span class="q">qw(IsFingerprintsFPFile)</span><span class="sc">;</span> | |
58 45 | |
59 46 <span class="i">%EXPORT_TAGS</span> = <span class="s">(</span><span class="w">all</span> <span class="cm">=></span> <span class="s">[</span><span class="i">@EXPORT</span><span class="cm">,</span> <span class="i">@EXPORT_OK</span><span class="s">]</span><span class="s">)</span><span class="sc">;</span> | |
60 47 | |
61 48 <span class="c"># Setup class variables...</span> | |
62 49 <span class="k">my</span><span class="s">(</span><span class="i">$ClassName</span><span class="s">)</span><span class="sc">;</span> | |
63 50 <span class="i">_InitializeClass</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
64 51 | |
65 52 <span class="c"># Class constructor...</span> | |
66 <a name="new-"></a> 53 <span class="k">sub </span><span class="m">new</span> <span class="s">{</span> | |
67 54 <span class="k">my</span><span class="s">(</span><span class="i">$Class</span><span class="cm">,</span> <span class="i">%NamesAndValues</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
68 55 | |
69 56 <span class="c"># Initialize object...</span> | |
70 57 <span class="k">my</span> <span class="i">$This</span> = <span class="i">$Class</span><span class="i">->SUPER::new</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
71 58 <span class="k">bless</span> <span class="i">$This</span><span class="cm">,</span> <span class="k">ref</span><span class="s">(</span><span class="i">$Class</span><span class="s">)</span> || <span class="i">$Class</span><span class="sc">;</span> | |
72 59 <span class="i">$This</span><span class="i">->_InitializeFingerprintsFPFileIO</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
73 60 | |
74 61 <span class="i">$This</span><span class="i">->_InitializeFingerprintsFPFileIOProperties</span><span class="s">(</span><span class="i">%NamesAndValues</span><span class="s">)</span><span class="sc">;</span> | |
75 62 | |
76 63 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
77 64 <span class="s">}</span> | |
78 65 | |
79 66 <span class="c"># Initialize object data...</span> | |
80 67 <span class="c">#</span> | |
81 <a name="_InitializeFingerprintsFPFileIO-"></a> 68 <span class="k">sub </span><span class="m">_InitializeFingerprintsFPFileIO</span> <span class="s">{</span> | |
82 69 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
83 70 | |
84 71 <span class="c"># Fingerprints string data format during read/write...</span> | |
85 72 <span class="c">#</span> | |
86 73 <span class="c"># For file read:</span> | |
87 74 <span class="c">#</span> | |
88 75 <span class="c"># AutoDetect - automatically detect format of fingerprints string</span> | |
89 76 <span class="c"># FingerprintsBitVectorString - Bit vector fingerprints string format</span> | |
90 77 <span class="c"># FingerprintsVectorString - Vector fingerprints string format</span> | |
91 78 <span class="c">#</span> | |
92 79 <span class="c"># Default value: AutoDetect</span> | |
93 80 <span class="c">#</span> | |
94 81 <span class="c"># For file write:</span> | |
95 82 <span class="c">#</span> | |
96 83 <span class="c"># FingerprintsBitVectorString - Bit vector fingerprints string format</span> | |
97 84 <span class="c"># FingerprintsVectorString - Vector fingerprints string format</span> | |
98 85 <span class="c">#</span> | |
99 86 <span class="c"># Default value: undef</span> | |
100 87 <span class="c">#</span> | |
101 88 <span class="i">$This</span>->{<span class="w">FingerprintsStringMode</span>} = <span class="k">undef</span><span class="sc">;</span> | |
102 89 | |
103 90 <span class="c"># For file read:</span> | |
104 91 <span class="c">#</span> | |
105 92 <span class="c"># o Fingerprints bit-vector and vector object for current fingerprints string</span> | |
106 93 <span class="c">#</span> | |
107 94 <span class="c"># For file write:</span> | |
108 95 <span class="c">#</span> | |
109 96 <span class="c"># o Fingerprints bit-vector and vector object for current fingerprints string</span> | |
110 97 <span class="c"># o Any supported fingerprints object: PathLengthFingerprints, ExtendedConnectivity, and so on.</span> | |
111 98 <span class="c">#</span> | |
112 99 <span class="i">$This</span>->{<span class="w">FingerprintsObject</span>} = <span class="k">undef</span><span class="sc">;</span> | |
113 100 | |
114 101 <span class="c"># Fingeprints string for current line during read/write...</span> | |
115 102 <span class="i">$This</span>->{<span class="w">FingerprintsString</span>} = <span class="k">undef</span><span class="sc">;</span> | |
116 103 | |
117 104 <span class="c"># Partial fingeprints string corresponding to what's on the current line for current</span> | |
118 105 <span class="c"># line during read/write...</span> | |
119 106 <span class="i">$This</span>->{<span class="w">PartialFingerprintsString</span>} = <span class="k">undef</span><span class="sc">;</span> | |
120 107 | |
121 108 <span class="c"># Required header data keys and values during read/write...</span> | |
122 109 <span class="i">@</span>{<span class="i">$This</span>->{<span class="w">RequiredHeaderDataKeys</span>}} = <span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
123 110 <span class="i">%</span>{<span class="i">$This</span>->{<span class="w">RequiredHeaderDataKeysAndValues</span>}} = <span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
124 111 | |
125 112 <span class="c"># First data line read/write...</span> | |
126 113 <span class="i">$This</span>->{<span class="w">FirstDataLineIO</span>} = <span class="n">1</span><span class="sc">;</span> | |
127 114 | |
128 115 <span class="c"># Current fingerprints string data line number during read/write...</span> | |
129 116 <span class="i">$This</span>->{<span class="w">LineNum</span>} = <span class="n">0</span><span class="sc">;</span> | |
130 117 | |
131 118 <span class="c"># FP line data during read/write...</span> | |
132 119 <span class="i">$This</span>->{<span class="w">DataLine</span>} = <span class="k">undef</span><span class="sc">;</span> | |
133 120 | |
134 121 <span class="c"># Initialize parameters for read...</span> | |
135 122 <span class="i">$This</span><span class="i">->_InitializeFingerprintsFPFileIORead</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
136 123 | |
137 124 <span class="c"># Initialize parameters for write...</span> | |
138 125 <span class="i">$This</span><span class="i">->_InitializeFingerprintsFPFileIOWrite</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
139 126 | |
140 127 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
141 128 <span class="s">}</span> | |
142 129 | |
143 130 <span class="c"># Initialize class ...</span> | |
144 <a name="_InitializeClass-"></a> 131 <span class="k">sub </span><span class="m">_InitializeClass</span> <span class="s">{</span> | |
145 132 <span class="c">#Class name...</span> | |
146 133 <span class="i">$ClassName</span> = <span class="w">__PACKAGE__</span><span class="sc">;</span> | |
147 134 | |
148 135 <span class="s">}</span> | |
149 136 | |
150 137 <span class="c"># Initialize object data for reading fingerprints FP file...</span> | |
151 138 <span class="c">#</span> | |
152 <a name="_InitializeFingerprintsFPFileIORead-"></a> 139 <span class="k">sub </span><span class="m">_InitializeFingerprintsFPFileIORead</span> <span class="s">{</span> | |
153 140 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
154 141 | |
155 142 <span class="c"># Header data keys and values...</span> | |
156 143 <span class="c">#</span> | |
157 144 <span class="i">@</span>{<span class="i">$This</span>->{<span class="w">HeaderDataKeys</span>}} = <span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
158 145 <span class="i">%</span>{<span class="i">$This</span>->{<span class="w">HeaderDataKeysAndValues</span>}} = <span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
159 146 <span class="i">%</span>{<span class="i">$This</span>->{<span class="w">CannonicalHeaderDataKeysAndValues</span>}} = <span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
160 147 | |
161 148 <span class="c"># By default, the fingerprints data is assumed to be valid and no validation is</span> | |
162 149 <span class="c"># performed before generating fingerprints objects...</span> | |
163 150 <span class="c">#</span> | |
164 151 <span class="i">$This</span>->{<span class="w">ValidateData</span>} = <span class="n">1</span><span class="sc">;</span> | |
165 152 | |
166 153 <span class="c"># Level of detail to print during validation of data for invalid or missing data...</span> | |
167 154 <span class="i">$This</span>->{<span class="w">DetailLevel</span>} = <span class="n">1</span><span class="sc">;</span> | |
168 155 | |
169 156 <span class="c"># Number of missing and invalid fingerprints string data lines...</span> | |
170 157 <span class="i">$This</span>->{<span class="w">NumOfLinesWithMissingData</span>} = <span class="n">0</span><span class="sc">;</span> | |
171 158 <span class="i">$This</span>->{<span class="w">NumOfLinesWithInvalidData</span>} = <span class="n">0</span><span class="sc">;</span> | |
172 159 | |
173 160 <span class="c"># Compound ID for current fingerprints string...</span> | |
174 161 <span class="i">$This</span>->{<span class="w">CompoundID</span>} = <span class="k">undef</span><span class="sc">;</span> | |
175 162 | |
176 163 <span class="c"># Status of data in fingerprints FP file...</span> | |
177 164 <span class="i">$This</span>->{<span class="w">ValidFileData</span>} = <span class="n">0</span><span class="sc">;</span> | |
178 165 <span class="i">$This</span>->{<span class="w">ValidRequiredHeaderDataKeys</span>} = <span class="n">0</span><span class="sc">;</span> | |
179 166 <span class="i">$This</span>->{<span class="w">ValidFingerprintsStringMode</span>} = <span class="n">0</span><span class="sc">;</span> | |
180 167 | |
181 168 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
182 169 <span class="s">}</span> | |
183 170 | |
184 171 <span class="c"># Initialize object data for writing fingerprints FP file...</span> | |
185 172 <span class="c">#</span> | |
186 <a name="_InitializeFingerprintsFPFileIOWrite-"></a> 173 <span class="k">sub </span><span class="m">_InitializeFingerprintsFPFileIOWrite</span> <span class="s">{</span> | |
187 174 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
188 175 | |
189 176 <span class="c"># Fingerprints bit vector string format...</span> | |
190 177 <span class="c">#</span> | |
191 178 <span class="c"># Possible values: BinaryString or HexadecimalString [Default]</span> | |
192 179 <span class="c">#</span> | |
193 180 <span class="c"># Default BitStringFormat is set during first write using Fingerprints::FingerprintsStringUtil::GetDefaultBitStringFormat.</span> | |
194 181 <span class="c">#</span> | |
195 182 <span class="i">$This</span>->{<span class="w">BitStringFormat</span>} = <span class="k">undef</span><span class="sc">;</span> | |
196 183 | |
197 184 <span class="c"># Bits order in fingerprints bit vector string...</span> | |
198 185 <span class="c">#</span> | |
199 186 <span class="c"># Ascending - First bit in each byte as the lowest bit [Default]</span> | |
200 187 <span class="c"># Descending - First bit in each byte as the highest bit</span> | |
201 188 <span class="c">#</span> | |
202 189 <span class="c"># Default BitsOrder is set during first write using Fingerprints::FingerprintsStringUtil::GetDefaultBitsOrder.</span> | |
203 190 <span class="c">#</span> | |
204 191 <span class="i">$This</span>->{<span class="w">BitsOrder</span>} = <span class="k">undef</span><span class="sc">;</span> | |
205 192 | |
206 193 <span class="c"># Fingerprints vector string format...</span> | |
207 194 <span class="c">#</span> | |
208 195 <span class="c"># Possible values: IDsAndValuesString, IDsAndValuesPairsString, ValuesAndIDsString, ValuesAndIDsPairsString, ValuesString</span> | |
209 196 <span class="c">#</span> | |
210 197 <span class="c"># Default VectorStringFormat is set during first write using Fingerprints::FingerprintsStringUtil::GetDefaultVectorStringFormat.</span> | |
211 198 <span class="c"># For fingerprints vector object containing vector NumericalValues, it corresponds to IDsAndValuesString; otherwise,</span> | |
212 199 <span class="c"># it's set to ValuesString.</span> | |
213 200 <span class="c">#</span> | |
214 201 <span class="i">$This</span>->{<span class="w">VectorStringFormat</span>} = <span class="k">undef</span><span class="sc">;</span> | |
215 202 | |
216 203 <span class="c"># Overwriting existing file...</span> | |
217 204 <span class="i">$This</span>->{<span class="w">Overwrite</span>} = <span class="n">0</span><span class="sc">;</span> | |
218 205 | |
219 206 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
220 207 <span class="s">}</span> | |
221 208 | |
222 209 <span class="c"># Initialize object values...</span> | |
223 <a name="_InitializeFingerprintsFPFileIOProperties-"></a> 210 <span class="k">sub </span><span class="m">_InitializeFingerprintsFPFileIOProperties</span> <span class="s">{</span> | |
224 211 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">%NamesAndValues</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
225 212 | |
226 213 <span class="c"># All other property names and values along with all Set/Get<PropertyName> methods</span> | |
227 214 <span class="c"># are implemented on-demand using ObjectProperty class.</span> | |
228 215 | |
229 216 <span class="k">my</span><span class="s">(</span><span class="i">$Name</span><span class="cm">,</span> <span class="i">$Value</span><span class="cm">,</span> <span class="i">$MethodName</span><span class="s">)</span><span class="sc">;</span> | |
230 217 <span class="k">while</span> <span class="s">(</span><span class="s">(</span><span class="i">$Name</span><span class="cm">,</span> <span class="i">$Value</span><span class="s">)</span> = <span class="k">each</span> <span class="i">%NamesAndValues</span><span class="s">)</span> <span class="s">{</span> | |
231 218 <span class="i">$MethodName</span> = <span class="q">"Set${Name}"</span><span class="sc">;</span> | |
232 219 <span class="i">$This</span><span class="i">->$MethodName</span><span class="s">(</span><span class="i">$Value</span><span class="s">)</span><span class="sc">;</span> | |
233 220 <span class="s">}</span> | |
234 221 | |
235 222 <span class="k">if</span> <span class="s">(</span>!<span class="k">exists</span> <span class="i">$NamesAndValues</span>{<span class="w">Name</span>}<span class="s">)</span> <span class="s">{</span> | |
236 223 <span class="w">croak</span> <span class="q">"Error: ${ClassName}->New: Object can't be instantiated without specifying file name..."</span><span class="sc">;</span> | |
237 224 <span class="s">}</span> | |
238 225 | |
239 226 <span class="c"># Make sure it's a fingerprints file...</span> | |
240 227 <span class="i">$Name</span> = <span class="i">$NamesAndValues</span>{<span class="w">Name</span>}<span class="sc">;</span> | |
241 228 <span class="k">if</span> <span class="s">(</span>!<span class="i">$This</span><span class="i">->IsFingerprintsFPFile</span><span class="s">(</span><span class="i">$Name</span><span class="s">)</span><span class="s">)</span> <span class="s">{</span> | |
242 229 <span class="w">croak</span> <span class="q">"Error: ${ClassName}->New: Object can't be instantiated: File, $Name, doesn't appear to be fingerprints format..."</span><span class="sc">;</span> | |
243 230 <span class="s">}</span> | |
244 231 | |
245 232 <span class="k">if</span> <span class="s">(</span><span class="i">$This</span><span class="i">->GetMode</span><span class="s">(</span><span class="s">)</span> =~ <span class="q">/^Read$/i</span><span class="s">)</span> <span class="s">{</span> | |
246 233 <span class="i">$This</span><span class="i">->_InitializeFingerprintsFPFileIOReadProperties</span><span class="s">(</span><span class="i">%NamesAndValues</span><span class="s">)</span><span class="sc">;</span> | |
247 234 <span class="s">}</span> | |
248 235 <span class="k">elsif</span> <span class="s">(</span><span class="i">$This</span><span class="i">->GetMode</span><span class="s">(</span><span class="s">)</span> =~ <span class="q">/^(Write|Append)$/i</span><span class="s">)</span> <span class="s">{</span> | |
249 236 <span class="i">$This</span><span class="i">->_InitializeFingerprintsFPFileIOWriteProperties</span><span class="s">(</span><span class="i">%NamesAndValues</span><span class="s">)</span><span class="sc">;</span> | |
250 237 <span class="s">}</span> | |
251 238 | |
252 239 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
253 240 <span class="s">}</span> | |
254 241 | |
255 242 <span class="c"># Initialize object properties for reading fingerprints FP file...</span> | |
256 243 <span class="c">#</span> | |
257 <a name="_InitializeFingerprintsFPFileIOReadProperties-"></a> 244 <span class="k">sub </span><span class="m">_InitializeFingerprintsFPFileIOReadProperties</span> <span class="s">{</span> | |
258 245 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">%NamesAndValues</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
259 246 | |
260 247 <span class="c"># Set default value for FingerprintsStringMode...</span> | |
261 248 <span class="k">if</span> <span class="s">(</span>!<span class="i">$This</span>->{<span class="w">FingerprintsStringMode</span>}<span class="s">)</span> <span class="s">{</span> | |
262 249 <span class="i">$This</span>->{<span class="w">FingerprintsStringMode</span>} = <span class="q">'AutoDetect'</span><span class="sc">;</span> | |
263 250 <span class="s">}</span> | |
264 251 | |
265 252 <span class="i">$This</span><span class="i">->_PrepareForReadingFingerprintsFPFileData</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
266 253 | |
267 254 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
268 255 <span class="s">}</span> | |
269 256 | |
270 257 <span class="c"># Initialize object properties for writing fingerprints FP file...</span> | |
271 258 <span class="c">#</span> | |
272 <a name="_InitializeFingerprintsFPFileIOWriteProperties-"></a> 259 <span class="k">sub </span><span class="m">_InitializeFingerprintsFPFileIOWriteProperties</span> <span class="s">{</span> | |
273 260 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">%NamesAndValues</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
274 261 | |
275 262 <span class="c"># Check FingerprintsStringMode value...</span> | |
276 263 <span class="k">if</span> <span class="s">(</span>!<span class="k">exists</span> <span class="i">$NamesAndValues</span>{<span class="w">FingerprintsStringMode</span>}<span class="s">)</span> <span class="s">{</span> | |
277 264 <span class="w">croak</span> <span class="q">"Error: ${ClassName}->New: Object can't be instantiated without specifying FingerprintsStringMode..."</span><span class="sc">;</span> | |
278 265 <span class="s">}</span> | |
279 266 | |
280 267 <span class="k">if</span> <span class="s">(</span><span class="i">$This</span>->{<span class="w">FingerprintsStringMode</span>} !~ <span class="q">/^(FingerprintsBitVectorString|FingerprintsVectorString)$/i</span><span class="s">)</span> <span class="s">{</span> | |
281 268 <span class="w">croak</span> <span class="q">"Error: ${ClassName}->New: Object can't be instantiated: FingerprintsStringMode value, $This->{FingerprintsStringMode}, is not valid; Supported values for write/append: FingerprintsBitVectorString or FingerprintsVectorString..."</span><span class="sc">;</span> | |
282 269 <span class="s">}</span> | |
283 270 | |
284 271 <span class="i">$This</span><span class="i">->_PrepareForWritingFingerprintsFPFileData</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
285 272 | |
286 273 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
287 274 <span class="s">}</span> | |
288 275 | |
289 276 <span class="c"># Set FingerprintsStringMode...</span> | |
290 277 <span class="c">#</span> | |
291 <a name="SetFingerprintsStringMode-"></a> 278 <span class="k">sub </span><span class="m">SetFingerprintsStringMode</span> <span class="s">{</span> | |
292 279 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">$Value</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
293 280 | |
294 281 <span class="c"># AutoDetect - automatically detect format of fingerprints string</span> | |
295 282 <span class="c"># FingerprintsBitVectorString - Bit vector fingerprints string format</span> | |
296 283 <span class="c"># FingerprintsVectorString - Vector fingerprints string format</span> | |
297 284 | |
298 285 <span class="k">if</span> <span class="s">(</span><span class="i">$Value</span> !~ <span class="q">/^(AutoDetect|FingerprintsBitVectorString|FingerprintsVectorString)$/i</span><span class="s">)</span> <span class="s">{</span> | |
299 286 <span class="w">croak</span> <span class="q">"Error: ${ClassName}->SetFingerprintsStringMode: FingerprintsStringMode value, $Value, is not valid; Supported values: AutoDetect, FingerprintsBitVectorString or FingerprintsVectorString..."</span><span class="sc">;</span> | |
300 287 <span class="s">}</span> | |
301 288 | |
302 289 <span class="i">$This</span>->{<span class="w">FingerprintsStringMode</span>} = <span class="i">$Value</span><span class="sc">;</span> | |
303 290 | |
304 291 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
305 292 <span class="s">}</span> | |
306 293 | |
307 294 <span class="c"># Set DetailLevel...</span> | |
308 295 <span class="c">#</span> | |
309 <a name="SetDetailLevel-"></a> 296 <span class="k">sub </span><span class="m">SetDetailLevel</span> <span class="s">{</span> | |
310 297 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">$Value</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
311 298 | |
312 299 <span class="k">if</span> <span class="s">(</span>!<span class="i">TextUtil::IsPositiveInteger</span><span class="s">(</span><span class="i">$Value</span><span class="s">)</span><span class="s">)</span> <span class="s">{</span> | |
313 300 <span class="w">croak</span> <span class="q">"Error: ${ClassName}->SetDetailLevel: DetailLevel value, $Value, is not valid; Supported values: > 0..."</span><span class="sc">;</span> | |
314 301 <span class="s">}</span> | |
315 302 | |
316 303 <span class="i">$This</span>->{<span class="w">DetailLevel</span>} = <span class="i">$Value</span><span class="sc">;</span> | |
317 304 | |
318 305 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
319 306 <span class="s">}</span> | |
320 307 | |
321 308 <span class="c"># Set BitStringFormat...</span> | |
322 309 <span class="c">#</span> | |
323 <a name="SetBitStringFormat-"></a> 310 <span class="k">sub </span><span class="m">SetBitStringFormat</span> <span class="s">{</span> | |
324 311 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">$Value</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
325 312 | |
326 313 <span class="k">if</span> <span class="s">(</span><span class="i">$Value</span> !~ <span class="q">/^(BinaryString|HexadecimalString)$/i</span><span class="s">)</span> <span class="s">{</span> | |
327 314 <span class="w">croak</span> <span class="q">"Error: ${ClassName}->SetBitStringFormat: BitStringFormat value, $Value, is not valid; Supported values: BinaryString or HexadecimalString..."</span><span class="sc">;</span> | |
328 315 <span class="s">}</span> | |
329 316 | |
330 317 <span class="i">$This</span>->{<span class="w">BitStringFormat</span>} = <span class="i">$Value</span><span class="sc">;</span> | |
331 318 | |
332 319 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
333 320 <span class="s">}</span> | |
334 321 | |
335 322 <span class="c"># Set BitsOrder...</span> | |
336 323 <span class="c">#</span> | |
337 <a name="SetBitsOrder-"></a> 324 <span class="k">sub </span><span class="m">SetBitsOrder</span> <span class="s">{</span> | |
338 325 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">$Value</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
339 326 | |
340 327 <span class="c"># Ascending - First bit in each byte as the lowest bit</span> | |
341 328 <span class="c"># Descending - First bit in each byte as the highest bit</span> | |
342 329 <span class="c">#</span> | |
343 330 <span class="k">if</span> <span class="s">(</span><span class="i">$Value</span> !~ <span class="q">/^(Ascending|Descending)$/i</span><span class="s">)</span> <span class="s">{</span> | |
344 331 <span class="w">croak</span> <span class="q">"Error: ${ClassName}->SetBitsOrder: FingerprintsStringMode value, $Value, is not valid; Supported values: Ascending or Descending..."</span><span class="sc">;</span> | |
345 332 <span class="s">}</span> | |
346 333 | |
347 334 <span class="i">$This</span>->{<span class="w">BitsOrder</span>} = <span class="i">$Value</span><span class="sc">;</span> | |
348 335 | |
349 336 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
350 337 <span class="s">}</span> | |
351 338 | |
352 339 <span class="c"># Set compound ID...</span> | |
353 340 <span class="c">#</span> | |
354 <a name="SetCompoundID-"></a> 341 <span class="k">sub </span><span class="m">SetCompoundID</span> <span class="s">{</span> | |
355 342 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">$Value</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
356 343 | |
357 344 <span class="k">if</span> <span class="s">(</span><span class="i">$Value</span> =~ <span class="q">/ /</span><span class="s">)</span> <span class="s">{</span> | |
358 345 <span class="i">$Value</span> =~ <span class="q">s/ //g</span><span class="sc">;</span> | |
359 346 <span class="w">carp</span> <span class="q">"Warning: ${ClassName}->SetCompoundID: Spaces are not allowed in compound ID; They have been removed..."</span><span class="sc">;</span> | |
360 347 <span class="s">}</span> | |
361 348 | |
362 349 <span class="i">$This</span>->{<span class="w">CompoundID</span>} = <span class="i">$Value</span><span class="sc">;</span> | |
363 350 | |
364 351 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
365 352 <span class="s">}</span> | |
366 353 | |
367 354 <span class="c"># Set VectorStringFormat...</span> | |
368 355 <span class="c">#</span> | |
369 <a name="SetVectorStringFormat-"></a> 356 <span class="k">sub </span><span class="m">SetVectorStringFormat</span> <span class="s">{</span> | |
370 357 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">$Value</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
371 358 | |
372 359 <span class="c"># Possible values: IDsAndValuesString, IDsAndValuesPairsString, ValuesAndIDsString, ValuesAndIDsPairsString</span> | |
373 360 | |
374 361 <span class="k">if</span> <span class="s">(</span><span class="i">$Value</span> !~ <span class="q">/^(IDsAndValuesString|IDsAndValuesPairsString|ValuesAndIDsString|ValuesAndIDsPairsString|ValuesString)$/i</span><span class="s">)</span> <span class="s">{</span> | |
375 362 <span class="w">croak</span> <span class="q">"Error: ${ClassName}->SetVectorStringFormat: FingerprintsStringMode value, $Value, is not valid; Supported values: IDsAndValuesString, IDsAndValuesPairsString, ValuesAndIDsString, ValuesAndIDsPairsString, or ValuesString..."</span><span class="sc">;</span> | |
376 363 <span class="s">}</span> | |
377 364 | |
378 365 <span class="i">$This</span>->{<span class="w">VectorStringFormat</span>} = <span class="i">$Value</span><span class="sc">;</span> | |
379 366 | |
380 367 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
381 368 <span class="s">}</span> | |
382 369 | |
383 370 <span class="c"># Get header data keys or number of header data keys in header data block...</span> | |
384 371 <span class="c">#</span> | |
385 <a name="GetHeaderDataKeys-"></a> 372 <span class="k">sub </span><span class="m">GetHeaderDataKeys</span> <span class="s">{</span> | |
386 373 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
387 374 | |
388 375 <span class="k">return</span> <span class="k">wantarray</span> ? <span class="i">@</span>{<span class="i">$This</span>->{<span class="w">HeaderDataKeys</span>}} <span class="co">:</span> <span class="k">scalar</span> <span class="i">@</span>{<span class="i">$This</span>->{<span class="w">HeaderDataKeys</span>}}<span class="sc">;</span> | |
389 376 <span class="s">}</span> | |
390 377 | |
391 378 <span class="c"># Set header data keys...</span> | |
392 379 <span class="c">#</span> | |
393 <a name="SetHeaderDataKeys-"></a> 380 <span class="k">sub </span><span class="m">SetHeaderDataKeys</span> <span class="s">{</span> | |
394 381 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">@Keys</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
395 382 | |
396 383 <span class="w">croak</span> <span class="q">"Error: ${ClassName}->SetHeaderDataKeys: Can't set HeaderDataKeys: Not allowed..."</span><span class="sc">;</span> | |
397 384 | |
398 385 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
399 386 <span class="s">}</span> | |
400 387 | |
401 388 <span class="c"># Get header data keys and values hash...</span> | |
402 389 <span class="c">#</span> | |
403 <a name="GetHeaderDataKeysAndValues-"></a> 390 <span class="k">sub </span><span class="m">GetHeaderDataKeysAndValues</span> <span class="s">{</span> | |
404 391 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
405 392 | |
406 393 <span class="k">return</span> <span class="i">%</span>{<span class="i">$This</span>->{<span class="w">HeaderDataKeysAndValues</span>}}<span class="sc">;</span> | |
407 394 <span class="s">}</span> | |
408 395 | |
409 396 <span class="c"># Set header data keys and values hash...</span> | |
410 397 <span class="c">#</span> | |
411 <a name="SetHeaderDataKeysAndValues-"></a> 398 <span class="k">sub </span><span class="m">SetHeaderDataKeysAndValues</span> <span class="s">{</span> | |
412 399 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">%KeysAndValues</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
413 400 | |
414 401 <span class="w">croak</span> <span class="q">"Error: ${ClassName}->SetHeaderDataKeysAndValues: Can't set HeaderDataKeysAndValues: Not allowed..."</span><span class="sc">;</span> | |
415 402 | |
416 403 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
417 404 <span class="s">}</span> | |
418 405 | |
419 406 <span class="c"># Get required header data keys or number of header data keys in header data block...</span> | |
420 407 <span class="c">#</span> | |
421 <a name="GetRequiredHeaderDataKeys-"></a> 408 <span class="k">sub </span><span class="m">GetRequiredHeaderDataKeys</span> <span class="s">{</span> | |
422 409 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
423 410 | |
424 411 <span class="k">return</span> <span class="k">wantarray</span> ? <span class="i">@</span>{<span class="i">$This</span>->{<span class="w">RequiredHeaderDataKeys</span>}} <span class="co">:</span> <span class="k">scalar</span> <span class="i">@</span>{<span class="i">$This</span>->{<span class="w">RequiredHeaderDataKeys</span>}}<span class="sc">;</span> | |
425 412 <span class="s">}</span> | |
426 413 | |
427 414 <span class="c"># Set required header data keys...</span> | |
428 415 <span class="c">#</span> | |
429 <a name="SetRequiredHeaderDataKeys-"></a> 416 <span class="k">sub </span><span class="m">SetRequiredHeaderDataKeys</span> <span class="s">{</span> | |
430 417 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">@Keys</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
431 418 | |
432 419 <span class="w">croak</span> <span class="q">"Error: ${ClassName}->SetRequiredHeaderDataKeys: Can't set RequiredHeaderDataKeys: Not allowed..."</span><span class="sc">;</span> | |
433 420 | |
434 421 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
435 422 <span class="s">}</span> | |
436 423 | |
437 424 <span class="c"># Get required header data keys and values hash...</span> | |
438 425 <span class="c">#</span> | |
439 <a name="GetRequiredHeaderDataKeysAndValues-"></a> 426 <span class="k">sub </span><span class="m">GetRequiredHeaderDataKeysAndValues</span> <span class="s">{</span> | |
440 427 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
441 428 | |
442 429 <span class="k">return</span> <span class="i">%</span>{<span class="i">$This</span>->{<span class="w">RequiredHeaderDataKeysAndValues</span>}}<span class="sc">;</span> | |
443 430 <span class="s">}</span> | |
444 431 | |
445 432 <span class="c"># Set required header data keys and values hash...</span> | |
446 433 <span class="c">#</span> | |
447 <a name="SetRequiredHeaderDataKeysAndValues-"></a> 434 <span class="k">sub </span><span class="m">SetRequiredHeaderDataKeysAndValues</span> <span class="s">{</span> | |
448 435 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">%KeysAndValues</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
449 436 | |
450 437 <span class="w">croak</span> <span class="q">"Error: ${ClassName}->SetRequiredHeaderDataKeysAndValues: Can't set RequiredHeaderDataKeysAndValues: Not allowed..."</span><span class="sc">;</span> | |
451 438 | |
452 439 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
453 440 <span class="s">}</span> | |
454 441 | |
455 442 <span class="c"># Get fingerprints object for current data line...</span> | |
456 443 <span class="c">#</span> | |
457 <a name="GetFingerprints-"></a> 444 <span class="k">sub </span><span class="m">GetFingerprints</span> <span class="s">{</span> | |
458 445 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
459 446 | |
460 447 <span class="k">return</span> <span class="i">$This</span>->{<span class="w">FingerprintsObject</span>}<span class="sc">;</span> | |
461 448 <span class="s">}</span> | |
462 449 | |
463 450 <span class="c"># Set fingerprints object for current data line...</span> | |
464 451 <span class="c">#</span> | |
465 <a name="SetFingerprints-"></a> 452 <span class="k">sub </span><span class="m">SetFingerprints</span> <span class="s">{</span> | |
466 453 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">$FingerprintsObject</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
467 454 | |
468 455 <span class="i">$This</span>->{<span class="w">FingerprintsObject</span>} = <span class="i">$FingerprintsObject</span><span class="sc">;</span> | |
469 456 | |
470 457 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
471 458 <span class="s">}</span> | |
472 459 | |
473 460 <span class="c"># Get fingerprints string for current data line...</span> | |
474 461 <span class="c">#</span> | |
475 <a name="GetFingerprintsString-"></a> 462 <span class="k">sub </span><span class="m">GetFingerprintsString</span> <span class="s">{</span> | |
476 463 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
477 464 | |
478 465 <span class="k">return</span> <span class="i">$This</span>->{<span class="w">FingerprintsString</span>} ? <span class="i">$This</span>->{<span class="w">FingerprintsString</span>} <span class="co">:</span> <span class="q">'None'</span><span class="sc">;</span> | |
479 466 <span class="s">}</span> | |
480 467 | |
481 468 <span class="c"># Set fingerprints string for current data line...</span> | |
482 469 <span class="c">#</span> | |
483 <a name="SetFingerprintsString-"></a> 470 <span class="k">sub </span><span class="m">SetFingerprintsString</span> <span class="s">{</span> | |
484 471 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">$FingerprintsString</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
485 472 | |
486 473 <span class="i">$This</span>->{<span class="w">FingerprintsString</span>} = <span class="i">$FingerprintsString</span><span class="sc">;</span> | |
487 474 | |
488 475 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
489 476 <span class="s">}</span> | |
490 477 | |
491 478 <span class="c"># Get partial fingerprints string for current data line...</span> | |
492 479 <span class="c">#</span> | |
493 <a name="GetPartialFingerprintsString-"></a> 480 <span class="k">sub </span><span class="m">GetPartialFingerprintsString</span> <span class="s">{</span> | |
494 481 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
495 482 | |
496 483 <span class="k">return</span> <span class="i">$This</span>->{<span class="w">PartialFingerprintsString</span>} ? <span class="i">$This</span>->{<span class="w">PartialFingerprintsString</span>} <span class="co">:</span> <span class="q">'None'</span><span class="sc">;</span> | |
497 484 <span class="s">}</span> | |
498 485 | |
499 486 <span class="c"># Set partial fingerprints string for current data line...</span> | |
500 487 <span class="c">#</span> | |
501 <a name="SetPartialFingerprintsString-"></a> 488 <span class="k">sub </span><span class="m">SetPartialFingerprintsString</span> <span class="s">{</span> | |
502 489 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">$PartialFingerprintsString</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
503 490 | |
504 491 <span class="i">$This</span>->{<span class="w">PartialFingerprintsString</span>} = <span class="i">$PartialFingerprintsString</span><span class="sc">;</span> | |
505 492 | |
506 493 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
507 494 <span class="s">}</span> | |
508 495 | |
509 496 <span class="c"># Does fingerprints FP file contain valid data?</span> | |
510 497 <span class="c">#</span> | |
511 <a name="IsFingerprintsFileDataValid-"></a> 498 <span class="k">sub </span><span class="m">IsFingerprintsFileDataValid</span> <span class="s">{</span> | |
512 499 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
513 500 | |
514 501 <span class="k">return</span> <span class="i">$This</span>->{<span class="w">ValidFileData</span>} ? <span class="n">1</span> <span class="co">:</span> <span class="n">0</span><span class="sc">;</span> | |
515 502 <span class="s">}</span> | |
516 503 | |
517 504 <span class="c"># Does current data line contains valid fingerprints object data?</span> | |
518 505 <span class="c">#</span> | |
519 <a name="IsFingerprintsDataValid-"></a> 506 <span class="k">sub </span><span class="m">IsFingerprintsDataValid</span> <span class="s">{</span> | |
520 507 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
521 508 | |
522 509 <span class="k">return</span> <span class="k">defined</span> <span class="i">$This</span>->{<span class="w">FingerprintsObject</span>} ? <span class="n">1</span> <span class="co">:</span> <span class="n">0</span><span class="sc">;</span> | |
523 510 <span class="s">}</span> | |
524 511 | |
525 512 <span class="c"># Check presence of a header data key...</span> | |
526 513 <span class="c">#</span> | |
527 <a name="IsHeaderDataKeyPresent-"></a> 514 <span class="k">sub </span><span class="m">IsHeaderDataKeyPresent</span> <span class="s">{</span> | |
528 515 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">$Key</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
529 516 <span class="k">my</span><span class="s">(</span><span class="i">$CannonicalKey</span><span class="s">)</span><span class="sc">;</span> | |
530 517 | |
531 518 <span class="i">$CannonicalKey</span> = <span class="k">lc</span> <span class="i">$Key</span><span class="sc">;</span> | |
532 519 | |
533 520 <span class="k">return</span> <span class="k">exists</span> <span class="i">$This</span>->{<span class="w">CannonicalHeaderDataKeysAndValues</span>}{<span class="i">$CannonicalKey</span>} ? <span class="n">1</span> <span class="co">:</span> <span class="n">0</span><span class="sc">;</span> | |
534 521 <span class="s">}</span> | |
535 522 | |
536 523 <span class="c"># Get value of header data key...</span> | |
537 524 <span class="c">#</span> | |
538 <a name="GetHeaderDataKeyValue-"></a> 525 <span class="k">sub </span><span class="m">GetHeaderDataKeyValue</span> <span class="s">{</span> | |
539 526 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">$Key</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
540 527 <span class="k">my</span><span class="s">(</span><span class="i">$CannonicalKey</span><span class="s">)</span><span class="sc">;</span> | |
541 528 | |
542 529 <span class="i">$CannonicalKey</span> = <span class="k">lc</span> <span class="i">$Key</span><span class="sc">;</span> | |
543 530 | |
544 531 <span class="k">return</span> <span class="k">exists</span> <span class="i">$This</span>->{<span class="w">CannonicalHeaderDataKeysAndValues</span>}{<span class="i">$CannonicalKey</span>} ? <span class="i">$This</span>->{<span class="w">CannonicalHeaderDataKeysAndValues</span>}{<span class="i">$CannonicalKey</span>} <span class="co">:</span> <span class="k">undef</span><span class="sc">;</span> | |
545 532 <span class="s">}</span> | |
546 533 | |
547 534 <span class="c">#</span> | |
548 535 <span class="c"># Read next available fingerprints line, process it and generate appropriate fingerprints</span> | |
549 536 <span class="c"># objects...</span> | |
550 537 <span class="c">#</span> | |
551 <a name="Read-"></a> 538 <span class="k">sub </span><span class="m">Read</span> <span class="s">{</span> | |
552 539 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
553 540 | |
554 541 <span class="c"># Read data line...</span> | |
555 542 <span class="k">if</span> <span class="s">(</span>!<span class="i">$This</span><span class="i">->_ReadDataLine</span><span class="s">(</span><span class="s">)</span><span class="s">)</span> <span class="s">{</span> | |
556 543 <span class="k">return</span> <span class="k">undef</span><span class="sc">;</span> | |
557 544 <span class="s">}</span> | |
558 545 | |
559 546 <span class="c"># No need to process invalid FP file with invalid data...</span> | |
560 547 <span class="k">if</span> <span class="s">(</span>!<span class="i">$This</span>->{<span class="w">ValidFileData</span>}<span class="s">)</span> <span class="s">{</span> | |
561 548 <span class="k">if</span> <span class="s">(</span><span class="i">$This</span>->{<span class="w">ValidateData</span>}<span class="s">)</span> <span class="s">{</span> | |
562 549 <span class="i">$This</span>->{<span class="w">NumOfLinesWithMissingData</span>} += <span class="n">1</span><span class="sc">;</span> | |
563 550 <span class="s">}</span> | |
564 551 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
565 552 <span class="s">}</span> | |
566 553 | |
567 554 <span class="c"># Perform data validation...</span> | |
568 555 <span class="k">if</span> <span class="s">(</span><span class="i">$This</span>->{<span class="w">ValidateData</span>}<span class="s">)</span> <span class="s">{</span> | |
569 556 <span class="k">if</span> <span class="s">(</span>!<span class="i">$This</span><span class="i">->_ValidateReadDataLine</span><span class="s">(</span><span class="s">)</span><span class="s">)</span> <span class="s">{</span> | |
570 557 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
571 558 <span class="s">}</span> | |
572 559 <span class="s">}</span> | |
573 560 | |
574 561 <span class="c"># Check again to handle problematic data for non-validated data lines...</span> | |
575 562 <span class="k">if</span> <span class="s">(</span>!<span class="i">$This</span>->{<span class="w">FingerprintsString</span>}<span class="s">)</span> <span class="s">{</span> | |
576 563 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
577 564 <span class="s">}</span> | |
578 565 | |
579 566 <span class="c"># Generate fingeprints object...</span> | |
580 567 <span class="i">$This</span><span class="i">->_GenerateFingerprintsObject</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
581 568 | |
582 569 <span class="c"># Setup fingerprints compound ID for fingerprints string...</span> | |
583 570 <span class="i">$This</span><span class="i">->_GenerateCompoundID</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
584 571 | |
585 572 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
586 573 <span class="s">}</span> | |
587 574 | |
588 575 <span class="c"># Read next available fingerprints line, process it and generate appropriate fingerprints</span> | |
589 576 <span class="c"># objects...</span> | |
590 577 <span class="c">#</span> | |
591 <a name="Next-"></a> 578 <span class="k">sub </span><span class="m">Next</span> <span class="s">{</span> | |
592 579 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
593 580 | |
594 581 <span class="k">return</span> <span class="i">$This</span><span class="i">->Read</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
595 582 <span class="s">}</span> | |
596 583 | |
597 584 <span class="c"># Read fingerprints data line line...</span> | |
598 585 <span class="c">#</span> | |
599 <a name="_ReadDataLine-"></a> 586 <span class="k">sub </span><span class="m">_ReadDataLine</span> <span class="s">{</span> | |
600 587 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
601 588 | |
602 589 <span class="c"># Initialize data for current line...</span> | |
603 590 <span class="i">$This</span><span class="i">->_InitializeReadDataLine</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
604 591 | |
605 592 <span class="k">if</span> <span class="s">(</span><span class="i">$This</span>->{<span class="w">FirstDataLineIO</span>}<span class="s">)</span> <span class="s">{</span> | |
606 593 <span class="c"># Get first data line...</span> | |
607 594 <span class="i">$This</span><span class="i">->_ProcessFirstDataLineRead</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
608 595 <span class="s">}</span> | |
609 596 <span class="k">else</span> <span class="s">{</span> | |
610 597 <span class="c"># Get next data line...</span> | |
611 598 <span class="i">$This</span>->{<span class="w">LineNum</span>} += <span class="n">1</span><span class="sc">;</span> | |
612 599 <span class="i">$This</span>->{<span class="w">DataLine</span>} = <span class="i">TextUtil::GetTextLine</span><span class="s">(</span><span class="i">$This</span>->{<span class="w">FileHandle</span>}<span class="s">)</span><span class="sc">;</span> | |
613 600 <span class="s">}</span> | |
614 601 | |
615 602 <span class="c"># Is it end of file?</span> | |
616 603 <span class="k">if</span> <span class="s">(</span>!<span class="i">$This</span>->{<span class="w">DataLine</span>}<span class="s">)</span> <span class="s">{</span> | |
617 604 <span class="k">return</span> <span class="n">0</span><span class="sc">;</span> | |
618 605 <span class="s">}</span> | |
619 606 | |
620 607 <span class="c"># Process data line to retrieve compound ID and fingerprints string information...</span> | |
621 608 <span class="i">$This</span><span class="i">->_ProcessDataLineRead</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
622 609 | |
623 610 <span class="k">return</span> <span class="n">1</span><span class="sc">;</span> | |
624 611 <span class="s">}</span> | |
625 612 | |
626 613 <span class="c"># Process data line to retrieve compound ID and fingerprints string information...</span> | |
627 614 <span class="c">#</span> | |
628 <a name="_ProcessDataLineRead-"></a> 615 <span class="k">sub </span><span class="m">_ProcessDataLineRead</span> <span class="s">{</span> | |
629 616 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
630 617 <span class="k">my</span><span class="s">(</span><span class="i">$CompoundID</span><span class="cm">,</span> <span class="i">$PartialFingerprintsString</span><span class="s">)</span><span class="sc">;</span> | |
631 618 | |
632 619 <span class="s">(</span><span class="i">$CompoundID</span><span class="cm">,</span> <span class="i">$PartialFingerprintsString</span><span class="s">)</span> = <span class="i">$This</span>->{<span class="w">DataLine</span>} =~ <span class="q">/^(.*?)[ ]+(.*?)$/</span><span class="sc">;</span> | |
633 620 | |
634 621 <span class="k">if</span> <span class="s">(</span>!<span class="s">(</span><span class="k">defined</span><span class="s">(</span><span class="i">$CompoundID</span><span class="s">)</span> && <span class="k">defined</span><span class="s">(</span><span class="i">$PartialFingerprintsString</span><span class="s">)</span><span class="s">)</span><span class="s">)</span> <span class="s">{</span> | |
635 622 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
636 623 <span class="s">}</span> | |
637 624 | |
638 625 <span class="i">$This</span>->{<span class="w">CompoundID</span>} = <span class="i">$CompoundID</span><span class="sc">;</span> | |
639 626 <span class="i">$This</span>->{<span class="w">PartialFingerprintsString</span>} = <span class="i">$PartialFingerprintsString</span><span class="sc">;</span> | |
640 627 | |
641 628 <span class="c"># Set up fingerprints string...</span> | |
642 629 <span class="i">$This</span><span class="i">->_GenerateFingerprintsStringFromPartialFingerprintsString</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
643 630 | |
644 631 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
645 632 <span class="s">}</span> | |
646 633 | |
647 634 <span class="c"># Initialize data line for reading...</span> | |
648 635 <span class="c">#</span> | |
649 <a name="_InitializeReadDataLine-"></a> 636 <span class="k">sub </span><span class="m">_InitializeReadDataLine</span> <span class="s">{</span> | |
650 637 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
651 638 | |
652 639 <span class="i">$This</span>->{<span class="w">CompoundID</span>} = <span class="k">undef</span><span class="sc">;</span> | |
653 640 <span class="i">$This</span>->{<span class="w">DataLine</span>} = <span class="k">undef</span><span class="sc">;</span> | |
654 641 | |
655 642 <span class="i">$This</span>->{<span class="w">FingerprintsObject</span>} = <span class="k">undef</span><span class="sc">;</span> | |
656 643 | |
657 644 <span class="i">$This</span>->{<span class="w">FingerprintsString</span>} = <span class="k">undef</span><span class="sc">;</span> | |
658 645 <span class="i">$This</span>->{<span class="w">PartialFingerprintsString</span>} = <span class="k">undef</span><span class="sc">;</span> | |
659 646 | |
660 647 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
661 648 <span class="s">}</span> | |
662 649 | |
663 650 <span class="c"># Validate fingerprints string data line...</span> | |
664 651 <span class="c">#</span> | |
665 <a name="_ValidateReadDataLine-"></a> 652 <span class="k">sub </span><span class="m">_ValidateReadDataLine</span> <span class="s">{</span> | |
666 653 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
667 654 | |
668 655 <span class="c"># Check for missing data...</span> | |
669 656 <span class="k">if</span> <span class="s">(</span>!<span class="s">(</span><span class="i">$This</span>->{<span class="w">CompoundID</span>} && <span class="i">$This</span>->{<span class="w">PartialFingerprintsString</span>}<span class="s">)</span><span class="s">)</span> <span class="s">{</span> | |
670 657 <span class="c"># Missing data...</span> | |
671 658 <span class="i">$This</span>->{<span class="w">NumOfLinesWithMissingData</span>} += <span class="n">1</span><span class="sc">;</span> | |
672 659 <span class="k">if</span> <span class="s">(</span><span class="i">$This</span>->{<span class="w">DetailLevel</span>} >= <span class="n">3</span><span class="s">)</span> <span class="s">{</span> | |
673 660 <span class="w">carp</span> <span class="q">"Warning: ${ClassName}->_ValidateReadDataLine: Data line number $This->{LineNum} contains no fingerprints data: $This->{DataLine}..."</span><span class="sc">;</span> | |
674 661 <span class="s">}</span> | |
675 662 <span class="k">elsif</span> <span class="s">(</span><span class="i">$This</span>->{<span class="w">DetailLevel</span>} >= <span class="n">2</span><span class="s">)</span> <span class="s">{</span> | |
676 663 <span class="w">carp</span> <span class="q">"Warning: ${ClassName}->_ValidateReadDataLine: Data line number $This->{LineNum} contains no fingerprints data..."</span><span class="sc">;</span> | |
677 664 <span class="s">}</span> | |
678 665 <span class="k">return</span> <span class="n">0</span><span class="sc">;</span> | |
679 666 <span class="s">}</span> | |
680 667 | |
681 668 <span class="c"># Check for invalid data...</span> | |
682 669 <span class="k">my</span><span class="s">(</span><span class="i">$InvalidFingerprintsData</span><span class="s">)</span><span class="sc">;</span> | |
683 670 | |
684 671 <span class="i">$InvalidFingerprintsData</span> = <span class="n">0</span><span class="sc">;</span> | |
685 672 <span class="k">if</span> <span class="s">(</span><span class="i">$This</span>->{<span class="w">FingerprintsString</span>}<span class="s">)</span> <span class="s">{</span> | |
686 673 <span class="i">$InvalidFingerprintsData</span> = <span class="i">Fingerprints::FingerprintsStringUtil::AreFingerprintsStringValuesValid</span><span class="s">(</span><span class="i">$This</span>->{<span class="w">FingerprintsString</span>}<span class="s">)</span> ? <span class="n">0</span> <span class="co">:</span> <span class="n">1</span><span class="sc">;</span> | |
687 674 <span class="s">}</span> | |
688 675 <span class="k">else</span> <span class="s">{</span> | |
689 676 <span class="i">$InvalidFingerprintsData</span> = <span class="n">1</span><span class="sc">;</span> | |
690 677 <span class="s">}</span> | |
691 678 | |
692 679 <span class="k">if</span> <span class="s">(</span><span class="i">$InvalidFingerprintsData</span><span class="s">)</span> <span class="s">{</span> | |
693 680 <span class="i">$This</span>->{<span class="w">NumOfLinesWithInvalidData</span>} += <span class="n">1</span><span class="sc">;</span> | |
694 681 <span class="k">if</span> <span class="s">(</span><span class="i">$This</span>->{<span class="w">DetailLevel</span>} >= <span class="n">3</span><span class="s">)</span> <span class="s">{</span> | |
695 682 <span class="w">carp</span> <span class="q">"Warning: ${ClassName}->_ValidateReadDataLine: Data line number $This->{LineNum} contains invalid fingerprints data: $This->{DataLine}..."</span><span class="sc">;</span> | |
696 683 <span class="s">}</span> | |
697 684 <span class="k">elsif</span> <span class="s">(</span><span class="i">$This</span>->{<span class="w">DetailLevel</span>} >= <span class="n">2</span><span class="s">)</span> <span class="s">{</span> | |
698 685 <span class="w">carp</span> <span class="q">"Warning: ${ClassName}->_ValidateReadDataLine: Data line number $This->{LineNum} contains invalid fingerprints data..."</span><span class="sc">;</span> | |
699 686 <span class="s">}</span> | |
700 687 <span class="k">return</span> <span class="n">0</span><span class="sc">;</span> | |
701 688 <span class="s">}</span> | |
702 689 | |
703 690 <span class="k">return</span> <span class="n">1</span><span class="sc">;</span> | |
704 691 <span class="s">}</span> | |
705 692 | |
706 693 <span class="c"># Setup fingerprints compound ID for fingerprints string...</span> | |
707 <a name="_GenerateCompoundID-"></a> 694 <span class="k">sub </span><span class="m">_GenerateCompoundID</span> <span class="s">{</span> | |
708 695 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
709 696 | |
710 697 <span class="c"># Set fingerprints ID...</span> | |
711 698 <span class="k">if</span> <span class="s">(</span><span class="i">$This</span>->{<span class="w">FingerprintsObject</span>}<span class="s">)</span> <span class="s">{</span> | |
712 699 <span class="i">$This</span>->{<span class="w">FingerprintsObject</span>}<span class="i">->SetID</span><span class="s">(</span><span class="i">$This</span>->{<span class="w">CompoundID</span>}<span class="s">)</span><span class="sc">;</span> | |
713 700 <span class="s">}</span> | |
714 701 | |
715 702 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
716 703 <span class="s">}</span> | |
717 704 | |
718 705 <span class="c"># Process first read...</span> | |
719 706 <span class="c">#</span> | |
720 <a name="_ProcessFirstDataLineRead-"></a> 707 <span class="k">sub </span><span class="m">_ProcessFirstDataLineRead</span> <span class="s">{</span> | |
721 708 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
722 709 <span class="k">my</span><span class="s">(</span><span class="i">$Line</span><span class="s">)</span><span class="sc">;</span> | |
723 710 | |
724 711 <span class="i">$This</span>->{<span class="w">FirstDataLineIO</span>} = <span class="n">0</span><span class="sc">;</span> | |
725 712 | |
726 713 <span class="c"># Skip over header data lines and collect first data line...</span> | |
727 714 | |
728 715 <span class="j">LINE:</span> <span class="k">while</span> <span class="s">(</span><span class="i">$Line</span> = <span class="i">TextUtil::GetTextLine</span><span class="s">(</span><span class="i">$This</span>->{<span class="w">FileHandle</span>}<span class="s">)</span><span class="s">)</span> <span class="s">{</span> | |
729 716 <span class="i">$This</span>->{<span class="w">LineNum</span>} += <span class="n">1</span><span class="sc">;</span> | |
730 717 | |
731 718 <span class="c"># Is it a header data line?</span> | |
732 719 <span class="k">if</span> <span class="s">(</span><span class="i">$Line</span> =~ <span class="q">/^#/</span><span class="s">)</span> <span class="s">{</span> | |
733 720 <span class="k">next</span> <span class="j">LINE</span><span class="sc">;</span> | |
734 721 <span class="s">}</span> | |
735 722 <span class="i">$This</span>->{<span class="w">DataLine</span>} = <span class="i">$Line</span><span class="sc">;</span> | |
736 723 <span class="k">last</span> <span class="j">LINE</span><span class="sc">;</span> | |
737 724 <span class="s">}</span> | |
738 725 | |
739 726 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
740 727 <span class="s">}</span> | |
741 728 | |
742 729 <span class="c"># Get ready for reading fingerprints FP file...</span> | |
743 730 <span class="c">#</span> | |
744 <a name="_PrepareForReadingFingerprintsFPFileData-"></a> 731 <span class="k">sub </span><span class="m">_PrepareForReadingFingerprintsFPFileData</span> <span class="s">{</span> | |
745 732 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
746 733 | |
747 734 <span class="c"># Retrieve FP file data headers information....</span> | |
748 735 <span class="i">$This</span><span class="i">->_RetrieveFPFileDataHeaders</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
749 736 | |
750 737 <span class="c"># Validate header data keys and values information...</span> | |
751 738 <span class="i">$This</span><span class="i">->_ValidateReadHeaderDataKeysAndValues</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
752 739 | |
753 740 <span class="c"># Validate fingeprints string mode information...</span> | |
754 741 <span class="k">if</span> <span class="s">(</span><span class="i">$This</span>->{<span class="w">ValidRequiredHeaderDataKeys</span>}<span class="s">)</span> <span class="s">{</span> | |
755 742 <span class="i">$This</span><span class="i">->_ValidateReadFingerprintsStringMode</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
756 743 <span class="s">}</span> | |
757 744 | |
758 745 <span class="c"># Set status of FP file data...</span> | |
759 746 <span class="i">$This</span>->{<span class="w">ValidFileData</span>} = <span class="s">(</span><span class="i">$This</span>->{<span class="w">ValidRequiredHeaderDataKeys</span>} && <span class="i">$This</span>->{<span class="w">ValidFingerprintsStringMode</span>}<span class="s">)</span> ? <span class="n">1</span> <span class="co">:</span> <span class="n">0</span><span class="sc">;</span> | |
760 747 | |
761 748 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
762 749 <span class="s">}</span> | |
763 750 | |
764 751 <span class="c"># Retrieve information about fingerprints date header in FP file...</span> | |
765 752 <span class="c">#</span> | |
766 <a name="_RetrieveFPFileDataHeaders-"></a> 753 <span class="k">sub </span><span class="m">_RetrieveFPFileDataHeaders</span> <span class="s">{</span> | |
767 754 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
768 755 <span class="k">my</span><span class="s">(</span><span class="i">$FPFile</span><span class="cm">,</span> <span class="i">$Line</span><span class="cm">,</span> <span class="i">$Index</span><span class="cm">,</span> <span class="i">$KeyValuePair</span><span class="cm">,</span> <span class="i">$Key</span><span class="cm">,</span> <span class="i">$Value</span><span class="cm">,</span> <span class="i">$KeyValueDelimiter</span><span class="cm">,</span> <span class="i">$KeyValuePairDelimiter</span><span class="cm">,</span> <span class="i">@LineKeyValuePairs</span><span class="s">)</span><span class="sc">;</span> | |
769 756 | |
770 757 <span class="i">$FPFile</span> = <span class="i">$This</span>->{<span class="w">Name</span>}<span class="sc">;</span> | |
771 758 | |
772 759 <span class="k">if</span> <span class="s">(</span>!<span class="s">(</span><span class="k">-e</span> <span class="i">$FPFile</span><span class="s">)</span><span class="s">)</span> <span class="s">{</span> | |
773 760 <span class="w">croak</span> <span class="q">"Error: ${ClassName}->_RetrieveFPFileDataHeaders: File, $FPFile, doesn't exist..."</span><span class="sc">;</span> | |
774 761 <span class="s">}</span> | |
775 762 | |
776 763 <span class="k">if</span> <span class="s">(</span>!<span class="k">open</span> <span class="w">FPFILE</span><span class="cm">,</span> <span class="q">"$FPFile"</span><span class="s">)</span> <span class="s">{</span> | |
777 764 <span class="w">croak</span> <span class="q">"Error: ${ClassName}->_RetrieveFPFileDataHeaders: Couldn't open input FP file $FPFile: $! ..."</span><span class="sc">;</span> | |
778 765 <span class="s">}</span> | |
779 766 | |
780 767 <span class="c"># Process header key/value pair data...</span> | |
781 768 <span class="c">#</span> | |
782 769 <span class="i">$KeyValueDelimiter</span> = <span class="q">'='</span><span class="sc">;</span> | |
783 770 <span class="i">$KeyValuePairDelimiter</span> = <span class="q">';'</span><span class="sc">;</span> | |
784 771 | |
785 772 <span class="i">@</span>{<span class="i">$This</span>->{<span class="w">HeaderDataKeys</span>}} = <span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
786 773 <span class="i">%</span>{<span class="i">$This</span>->{<span class="w">HeaderDataKeysAndValues</span>}} = <span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
787 774 <span class="i">%</span>{<span class="i">$This</span>->{<span class="w">CannonicalHeaderDataKeysAndValues</span>}} = <span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
788 775 | |
789 776 <span class="j">LINE:</span> <span class="k">while</span> <span class="s">(</span><span class="i">$Line</span> = <span class="i">TextUtil::GetTextLine</span><span class="s">(</span>\<span class="i">*FPFILE</span><span class="s">)</span><span class="s">)</span> <span class="s">{</span> | |
790 777 <span class="c"># Is it a key/value pairs line?</span> | |
791 778 <span class="k">if</span> <span class="s">(</span><span class="i">$Line</span> !~ <span class="q">/^#/</span><span class="s">)</span> <span class="s">{</span> | |
792 779 <span class="k">last</span> <span class="j">LINE</span><span class="sc">;</span> | |
793 780 <span class="s">}</span> | |
794 781 | |
795 782 <span class="c"># Take out starting hash mark before processing key/value pairs...</span> | |
796 783 <span class="i">$Line</span> =~ <span class="q">s/^#//</span><span class="sc">;</span> | |
797 784 <span class="k">if</span> <span class="s">(</span><span class="i">TextUtil::IsEmpty</span><span class="s">(</span><span class="i">$Line</span><span class="s">)</span><span class="s">)</span> <span class="s">{</span> | |
798 785 <span class="k">next</span> <span class="j">LINE</span><span class="sc">;</span> | |
799 786 <span class="s">}</span> | |
800 787 | |
801 788 <span class="i">@LineKeyValuePairs</span> = <span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
802 789 | |
803 790 <span class="k">for</span> <span class="i">$KeyValuePair</span> <span class="s">(</span><span class="k">split</span> <span class="q">"$KeyValuePairDelimiter"</span><span class="cm">,</span> <span class="i">$Line</span><span class="s">)</span> <span class="s">{</span> | |
804 791 <span class="s">(</span><span class="i">$Key</span><span class="cm">,</span> <span class="i">$Value</span><span class="s">)</span> = <span class="k">split</span> <span class="q">"$KeyValueDelimiter"</span><span class="cm">,</span> <span class="i">$KeyValuePair</span><span class="sc">;</span> | |
805 792 | |
806 793 <span class="i">$Key</span> = <span class="k">defined</span><span class="s">(</span><span class="i">$Key</span><span class="s">)</span> ? <span class="i">TextUtil::RemoveLeadingAndTrailingWhiteSpaces</span><span class="s">(</span><span class="i">$Key</span><span class="s">)</span> <span class="co">:</span> <span class="q">''</span><span class="sc">;</span> | |
807 794 <span class="i">$Value</span> = <span class="k">defined</span><span class="s">(</span><span class="i">$Value</span><span class="s">)</span> ? <span class="i">TextUtil::RemoveLeadingAndTrailingWhiteSpaces</span><span class="s">(</span><span class="i">$Value</span><span class="s">)</span> <span class="co">:</span> <span class="q">''</span><span class="sc">;</span> | |
808 795 | |
809 796 <span class="k">if</span> <span class="s">(</span><span class="i">TextUtil::IsEmpty</span><span class="s">(</span><span class="i">$Key</span><span class="s">)</span> || <span class="i">TextUtil::IsEmpty</span><span class="s">(</span><span class="i">$Value</span><span class="s">)</span><span class="s">)</span> <span class="s">{</span> | |
810 797 <span class="w">carp</span> <span class="q">"Warning: ${ClassName}->_RetrieveFPFileDataHeaders: Data header line containing \"Key = Value\" pairs is not valid: It must contain even number of \"Key = Value\" pairs with valid values. Ignoring data header line: \"$Line\"..."</span><span class="sc">;</span> | |
811 798 <span class="k">next</span> <span class="j">LINE</span><span class="sc">;</span> | |
812 799 <span class="s">}</span> | |
813 800 <span class="k">push</span> <span class="i">@</span>{<span class="i">$This</span>->{<span class="w">HeaderDataKeys</span>}}<span class="cm">,</span> <span class="i">$Key</span><span class="sc">;</span> | |
814 801 <span class="k">push</span> <span class="i">@LineKeyValuePairs</span><span class="cm">,</span> <span class="s">(</span><span class="i">$Key</span><span class="cm">,</span> <span class="i">$Value</span><span class="s">)</span><span class="sc">;</span> | |
815 802 <span class="s">}</span> | |
816 803 | |
817 804 <span class="k">for</span> <span class="s">(</span><span class="i">$Index</span> = <span class="n">0</span><span class="sc">;</span> <span class="i">$Index</span> < <span class="i">$#LineKeyValuePairs</span><span class="sc">;</span> <span class="i">$Index</span> += <span class="n">2</span><span class="s">)</span> <span class="s">{</span> | |
818 805 <span class="i">$Key</span> = <span class="i">$LineKeyValuePairs</span>[<span class="i">$Index</span>]<span class="sc">;</span> <span class="i">$Value</span> = <span class="i">$LineKeyValuePairs</span>[<span class="i">$Index</span> + <span class="n">1</span>]<span class="sc">;</span> | |
819 806 | |
820 807 <span class="i">$This</span>->{<span class="w">HeaderDataKeysAndValues</span>}{<span class="i">$Key</span>} = <span class="i">$Value</span><span class="sc">;</span> | |
821 808 <span class="i">$This</span>->{<span class="w">CannonicalHeaderDataKeysAndValues</span>}{<span class="k">lc</span><span class="s">(</span><span class="i">$Key</span><span class="s">)</span>} = <span class="i">$Value</span><span class="sc">;</span> | |
822 809 <span class="s">}</span> | |
823 810 <span class="s">}</span> | |
824 811 <span class="k">close</span> <span class="w">FPFILE</span><span class="sc">;</span> | |
825 812 | |
826 813 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
827 814 <span class="s">}</span> | |
828 815 | |
829 816 <span class="c"># Validate header data and keys...</span> | |
830 817 <span class="c">#</span> | |
831 <a name="_ValidateReadHeaderDataKeysAndValues-"></a> 818 <span class="k">sub </span><span class="m">_ValidateReadHeaderDataKeysAndValues</span> <span class="s">{</span> | |
832 819 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
833 820 <span class="k">my</span><span class="s">(</span><span class="i">$FingerprintsStringType</span><span class="cm">,</span> <span class="i">$Key</span><span class="cm">,</span> <span class="i">$Value</span><span class="cm">,</span> <span class="i">@RequiredHeaderDataKeys</span><span class="s">)</span><span class="sc">;</span> | |
834 821 | |
835 822 <span class="i">$This</span>->{<span class="w">ValidRequiredHeaderDataKeys</span>} = <span class="n">0</span><span class="sc">;</span> | |
836 823 <span class="i">@</span>{<span class="i">$This</span>->{<span class="w">RequiredHeaderDataKeys</span>}} = <span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
837 824 | |
838 825 <span class="c"># Is FingerprintsStringType key is present?</span> | |
839 826 <span class="k">if</span> <span class="s">(</span>!<span class="i">$This</span><span class="i">->IsHeaderDataKeyPresent</span><span class="s">(</span><span class="q">'FingerprintsStringType'</span><span class="s">)</span><span class="s">)</span> <span class="s">{</span> | |
840 827 <span class="w">carp</span> <span class="q">"carp: ${ClassName}->_ValidateReadHeaderDataKeysAndValues: FingerprintsStringType data header key is missing in fingerprints file..."</span><span class="sc">;</span> | |
841 828 <span class="k">return</span> <span class="n">0</span><span class="sc">;</span> | |
842 829 <span class="s">}</span> | |
843 830 <span class="i">$FingerprintsStringType</span> = <span class="i">$This</span><span class="i">->GetHeaderDataKeyValue</span><span class="s">(</span><span class="q">'FingerprintsStringType'</span><span class="s">)</span><span class="sc">;</span> | |
844 831 | |
845 832 <span class="c"># Are all required data header keys present?</span> | |
846 833 <span class="c">#</span> | |
847 834 <span class="i">@RequiredHeaderDataKeys</span> = <span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
848 835 | |
849 836 <span class="k">if</span> <span class="s">(</span><span class="i">$FingerprintsStringType</span> =~ <span class="q">/^(FingerprintsBitVector|FingerprintsVector)$/i</span><span class="s">)</span> <span class="s">{</span> | |
850 837 <span class="k">push</span> <span class="i">@RequiredHeaderDataKeys</span><span class="cm">,</span> <span class="i">$This</span><span class="i">->_GetRequiredHeaderDataKeys</span><span class="s">(</span><span class="i">$FingerprintsStringType</span><span class="s">)</span><span class="sc">;</span> | |
851 838 <span class="s">}</span> | |
852 839 <span class="k">else</span> <span class="s">{</span> | |
853 840 <span class="w">carp</span> <span class="q">"Warning: ${ClassName}->_ValidateReadHeaderDataKeysAndValues: FingerprintsStringType data header key value, $FingerprintsStringType, is not valid. SUpported values: FingerprintsBitVector or FingerprintsVector..."</span><span class="sc">;</span> | |
854 841 <span class="k">return</span> <span class="n">0</span><span class="sc">;</span> | |
855 842 <span class="s">}</span> | |
856 843 | |
857 844 <span class="k">for</span> <span class="i">$Key</span> <span class="s">(</span><span class="i">@RequiredHeaderDataKeys</span><span class="s">)</span> <span class="s">{</span> | |
858 845 <span class="k">if</span> <span class="s">(</span>!<span class="i">$This</span><span class="i">->IsHeaderDataKeyPresent</span><span class="s">(</span><span class="i">$Key</span><span class="s">)</span><span class="s">)</span> <span class="s">{</span> | |
859 846 <span class="w">croak</span> <span class="q">"Error: ${ClassName}->_ValidateReadHeaderDataKeysAndValues: Requires data header key, $Key, is missing in fingerprints file..."</span><span class="sc">;</span> | |
860 847 <span class="s">}</span> | |
861 848 <span class="s">}</span> | |
862 849 | |
863 850 <span class="k">push</span> <span class="i">@</span>{<span class="i">$This</span>->{<span class="w">RequiredHeaderDataKeys</span>}}<span class="cm">,</span> <span class="i">@RequiredHeaderDataKeys</span><span class="sc">;</span> | |
864 851 | |
865 852 <span class="c"># Are all required data header key values valid?</span> | |
866 853 <span class="c">#</span> | |
867 854 <span class="k">if</span> <span class="s">(</span>!<span class="i">$This</span><span class="i">->_ValidateRequiredHeaderDataKeyValues</span><span class="s">(</span><span class="s">)</span><span class="s">)</span> <span class="s">{</span> | |
868 855 <span class="k">return</span> <span class="n">0</span><span class="sc">;</span> | |
869 856 <span class="s">}</span> | |
870 857 | |
871 858 <span class="c"># Process required header key values...</span> | |
872 859 <span class="c">#</span> | |
873 860 <span class="i">$This</span><span class="i">->_ProcessRequiredHeaderDataKeyValues</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
874 861 | |
875 862 <span class="i">$This</span>->{<span class="w">ValidRequiredHeaderDataKeys</span>} = <span class="n">1</span><span class="sc">;</span> | |
876 863 | |
877 864 <span class="k">return</span> <span class="n">1</span><span class="sc">;</span> | |
878 865 <span class="s">}</span> | |
879 866 | |
880 867 <span class="c"># Validate data header key values....</span> | |
881 868 <span class="c">#</span> | |
882 <a name="_ValidateRequiredHeaderDataKeyValues-"></a> 869 <span class="k">sub </span><span class="m">_ValidateRequiredHeaderDataKeyValues</span> <span class="s">{</span> | |
883 870 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
884 871 <span class="k">my</span><span class="s">(</span><span class="i">$Key</span><span class="cm">,</span> <span class="i">$Value</span><span class="s">)</span><span class="sc">;</span> | |
885 872 | |
886 873 <span class="k">for</span> <span class="i">$Key</span> <span class="s">(</span><span class="i">@</span>{<span class="i">$This</span>->{<span class="w">RequiredHeaderDataKeys</span>}}<span class="s">)</span> <span class="s">{</span> | |
887 874 <span class="i">$Value</span> = <span class="i">$This</span><span class="i">->GetHeaderDataKeyValue</span><span class="s">(</span><span class="i">$Key</span><span class="s">)</span><span class="sc">;</span> | |
888 875 <span class="j">KEY:</span> <span class="s">{</span> | |
889 876 <span class="k">if</span> <span class="s">(</span><span class="i">$Key</span> =~ <span class="q">/^FingerprintsStringType$/i</span><span class="s">)</span> <span class="s">{</span> | |
890 877 <span class="k">if</span> <span class="s">(</span><span class="i">$Value</span> !~ <span class="q">/^(FingerprintsBitVector|FingerprintsVector)$/i</span><span class="s">)</span> <span class="s">{</span> | |
891 878 <span class="w">carp</span> <span class="q">"Warning: ${ClassName}->_ValidateRequiredHeaderDataKeyValues: Required $Key data header key value, $Value, is not valid. Supported values: FingerprintsBitVector or FingerprintsVector..."</span><span class="sc">;</span> | |
892 879 <span class="k">return</span> <span class="n">0</span><span class="sc">;</span> | |
893 880 <span class="s">}</span> | |
894 881 <span class="k">last</span> <span class="j">KEY</span><span class="sc">;</span> | |
895 882 <span class="s">}</span> | |
896 883 <span class="k">if</span> <span class="s">(</span><span class="i">$Key</span> =~ <span class="q">/^Size$/i</span><span class="s">)</span> <span class="s">{</span> | |
897 884 <span class="k">if</span> <span class="s">(</span>!<span class="i">TextUtil::IsPositiveInteger</span><span class="s">(</span><span class="i">$Value</span><span class="s">)</span><span class="s">)</span> <span class="s">{</span> | |
898 885 <span class="w">carp</span> <span class="q">"Warning: ${ClassName}->_ValidateRequiredHeaderDataKeyValues: Required $Key data header key value, $Value, is not valid. Supported values: > 0..."</span><span class="sc">;</span> | |
899 886 <span class="k">return</span> <span class="n">0</span><span class="sc">;</span> | |
900 887 <span class="s">}</span> | |
901 888 <span class="k">last</span> <span class="j">KEY</span><span class="sc">;</span> | |
902 889 <span class="s">}</span> | |
903 890 <span class="k">if</span> <span class="s">(</span><span class="i">$Key</span> =~ <span class="q">/^BitStringFormat$/i</span><span class="s">)</span> <span class="s">{</span> | |
904 891 <span class="k">if</span> <span class="s">(</span><span class="i">$Value</span> !~ <span class="q">/^(BinaryString|HexadecimalString)$/i</span><span class="s">)</span> <span class="s">{</span> | |
905 892 <span class="w">carp</span> <span class="q">"Warning: ${ClassName}->_ValidateRequiredHeaderDataKeyValues: Required $Key data header key value, $Value, is not valid. Supported values: BinaryString or HexadecimalString ..."</span><span class="sc">;</span> | |
906 893 <span class="k">return</span> <span class="n">0</span><span class="sc">;</span> | |
907 894 <span class="s">}</span> | |
908 895 <span class="k">last</span> <span class="j">KEY</span><span class="sc">;</span> | |
909 896 <span class="s">}</span> | |
910 897 <span class="k">if</span> <span class="s">(</span><span class="i">$Key</span> =~ <span class="q">/^BitsOrder$/i</span><span class="s">)</span> <span class="s">{</span> | |
911 898 <span class="k">if</span> <span class="s">(</span><span class="i">$Value</span> !~ <span class="q">/^(Ascending|Descending)$/i</span><span class="s">)</span> <span class="s">{</span> | |
912 899 <span class="w">carp</span> <span class="q">"Warning: ${ClassName}->_ValidateRequiredHeaderDataKeyValues: Required $Key data header key value, $Value, is not valid. Supported values: Ascending or Descending..."</span><span class="sc">;</span> | |
913 900 <span class="k">return</span> <span class="n">0</span><span class="sc">;</span> | |
914 901 <span class="s">}</span> | |
915 902 <span class="k">last</span> <span class="j">KEY</span><span class="sc">;</span> | |
916 903 <span class="s">}</span> | |
917 904 <span class="k">if</span> <span class="s">(</span><span class="i">$Key</span> =~ <span class="q">/^VectorStringFormat$/i</span><span class="s">)</span> <span class="s">{</span> | |
918 905 <span class="k">if</span> <span class="s">(</span><span class="i">$Value</span> !~ <span class="q">/^(IDsAndValuesString|IDsAndValuesPairsString|ValuesAndIDsString|ValuesAndIDsPairsString|ValuesString)$/i</span><span class="s">)</span> <span class="s">{</span> | |
919 906 <span class="w">carp</span> <span class="q">"Warning: ${ClassName}->_ValidateRequiredHeaderDataKeyValues: Required $Key data header key value, $Value, is not valid. Supported values: IDsAndValuesString, IDsAndValuesPairsString, ValuesAndIDsString, ValuesAndIDsPairsString, or ValuesString ..."</span><span class="sc">;</span> | |
920 907 <span class="k">return</span> <span class="n">0</span><span class="sc">;</span> | |
921 908 <span class="s">}</span> | |
922 909 <span class="k">last</span> <span class="j">KEY</span><span class="sc">;</span> | |
923 910 <span class="s">}</span> | |
924 911 <span class="k">if</span> <span class="s">(</span><span class="i">$Key</span> =~ <span class="q">/^VectorValuesType$/i</span><span class="s">)</span> <span class="s">{</span> | |
925 912 <span class="k">if</span> <span class="s">(</span><span class="i">$Value</span> !~ <span class="q">/^(OrderedNumericalValues|NumericalValues|AlphaNumericalValues)$/i</span><span class="s">)</span> <span class="s">{</span> | |
926 913 <span class="w">carp</span> <span class="q">"Warning: ${ClassName}->_ValidateRequiredHeaderDataKeyValues: Required $Key data header key value, $Value, is not valid. Supported values: OrderedNumericalValues, NumericalValues or AlphaNumericalValues..."</span><span class="sc">;</span> | |
927 914 <span class="k">return</span> <span class="n">0</span><span class="sc">;</span> | |
928 915 <span class="s">}</span> | |
929 916 <span class="k">last</span> <span class="j">KEY</span><span class="sc">;</span> | |
930 917 <span class="s">}</span> | |
931 918 <span class="k">if</span> <span class="s">(</span><span class="i">$Key</span> =~ <span class="q">/^Description$/i</span><span class="s">)</span> <span class="s">{</span> | |
932 919 <span class="k">if</span> <span class="s">(</span><span class="i">TextUtil::IsEmpty</span><span class="s">(</span><span class="i">$Value</span><span class="s">)</span><span class="s">)</span> <span class="s">{</span> | |
933 920 <span class="w">carp</span> <span class="q">"Warning: ${ClassName}->_ValidateRequiredHeaderDataKeyValues: Required $Key data header key value is not valid. Supported value: A no-empty text string..."</span><span class="sc">;</span> | |
934 921 <span class="k">return</span> <span class="n">0</span><span class="sc">;</span> | |
935 922 <span class="s">}</span> | |
936 923 <span class="k">last</span> <span class="j">KEY</span><span class="sc">;</span> | |
937 924 <span class="s">}</span> | |
938 925 <span class="w">carp</span> <span class="q">"Warning: ${ClassName}->_ValidateRequiredHeaderDataKeyValues: Required $Key data header key is not not supported..."</span><span class="sc">;</span> | |
939 926 <span class="k">return</span> <span class="n">0</span><span class="sc">;</span> | |
940 927 <span class="s">}</span> | |
941 928 <span class="s">}</span> | |
942 929 | |
943 930 <span class="k">return</span> <span class="n">1</span><span class="sc">;</span> | |
944 931 <span class="s">}</span> | |
945 932 | |
946 933 <span class="c"># Process required header key valeues for access during complete fingerprints</span> | |
947 934 <span class="c"># string generation from a partial fingerprints string specified on fingerprints</span> | |
948 935 <span class="c"># line...</span> | |
949 936 <span class="c">#</span> | |
950 <a name="_ProcessRequiredHeaderDataKeyValues-"></a> 937 <span class="k">sub </span><span class="m">_ProcessRequiredHeaderDataKeyValues</span> <span class="s">{</span> | |
951 938 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
952 939 <span class="k">my</span><span class="s">(</span><span class="i">$Key</span><span class="cm">,</span> <span class="i">$Value</span><span class="cm">,</span> <span class="i">@Keys</span><span class="s">)</span><span class="sc">;</span> | |
953 940 | |
954 941 <span class="i">%</span>{<span class="i">$This</span>->{<span class="w">RequiredHeaderDataKeysAndValues</span>}} = <span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
955 942 | |
956 943 <span class="k">for</span> <span class="i">$Key</span> <span class="s">(</span><span class="i">@</span>{<span class="i">$This</span>->{<span class="w">RequiredHeaderDataKeys</span>}}<span class="s">)</span> <span class="s">{</span> | |
957 944 <span class="i">$Value</span> = <span class="i">$This</span><span class="i">->GetHeaderDataKeyValue</span><span class="s">(</span><span class="i">$Key</span><span class="s">)</span><span class="sc">;</span> | |
958 945 <span class="i">$This</span>->{<span class="w">RequiredHeaderDataKeysAndValues</span>}{<span class="i">$Key</span>} = <span class="i">$Value</span><span class="sc">;</span> | |
959 946 <span class="s">}</span> | |
960 947 | |
961 948 <span class="c"># Setup prefixes for generating fingerprints strings...</span> | |
962 949 <span class="i">$This</span>->{<span class="w">FingerprintsBitVectorStringPrefix</span>} = <span class="q">''</span><span class="sc">;</span> | |
963 950 <span class="i">$This</span>->{<span class="w">FingerprintsVectorStringPrefix1</span>} = <span class="q">''</span><span class="sc">;</span> | |
964 951 <span class="i">$This</span>->{<span class="w">FingerprintsVectorStringPrefix2</span>} = <span class="q">''</span><span class="sc">;</span> | |
965 952 | |
966 953 <span class="k">if</span> <span class="s">(</span><span class="i">$This</span>->{<span class="w">RequiredHeaderDataKeysAndValues</span>}{<span class="w">FingerprintsStringType</span>} =~ <span class="q">/^FingerprintsBitVector$/i</span><span class="s">)</span> <span class="s">{</span> | |
967 954 <span class="i">@Keys</span> = <span class="q">qw(FingerprintsStringType Description Size BitStringFormat BitsOrder)</span><span class="sc">;</span> | |
968 955 <span class="i">$This</span>->{<span class="w">FingerprintsBitVectorStringPrefix</span>} = <span class="i">$This</span><span class="i">->_GenerateFingerprintsPrefixUsingKeys</span><span class="s">(</span><span class="i">@Keys</span><span class="s">)</span><span class="sc">;</span> | |
969 956 <span class="s">}</span> | |
970 957 <span class="k">elsif</span> <span class="s">(</span><span class="i">$This</span>->{<span class="w">RequiredHeaderDataKeysAndValues</span>}{<span class="w">FingerprintsStringType</span>} =~ <span class="q">/^FingerprintsVector$/i</span><span class="s">)</span> <span class="s">{</span> | |
971 958 <span class="i">@Keys</span> = <span class="q">qw(FingerprintsStringType Description)</span><span class="sc">;</span> | |
972 959 <span class="i">$This</span>->{<span class="w">FingerprintsVectorStringPrefix1</span>} = <span class="i">$This</span><span class="i">->_GenerateFingerprintsPrefixUsingKeys</span><span class="s">(</span><span class="i">@Keys</span><span class="s">)</span><span class="sc">;</span> | |
973 960 | |
974 961 <span class="i">@Keys</span> = <span class="q">qw(VectorValuesType VectorStringFormat)</span><span class="sc">;</span> | |
975 962 <span class="i">$This</span>->{<span class="w">FingerprintsVectorStringPrefix2</span>} = <span class="i">$This</span><span class="i">->_GenerateFingerprintsPrefixUsingKeys</span><span class="s">(</span><span class="i">@Keys</span><span class="s">)</span><span class="sc">;</span> | |
976 963 <span class="s">}</span> | |
977 964 | |
978 965 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
979 966 <span class="s">}</span> | |
980 967 | |
981 968 <span class="c"># Generate fingerprints prefix using header keys data...</span> | |
982 969 <span class="c">#</span> | |
983 <a name="_GenerateFingerprintsPrefixUsingKeys-"></a> 970 <span class="k">sub </span><span class="m">_GenerateFingerprintsPrefixUsingKeys</span> <span class="s">{</span> | |
984 971 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">@Keys</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
985 972 <span class="k">my</span><span class="s">(</span><span class="i">$Delimiter</span><span class="cm">,</span> <span class="i">$Key</span><span class="cm">,</span> <span class="i">@Values</span><span class="s">)</span><span class="sc">;</span> | |
986 973 | |
987 974 <span class="i">$Delimiter</span> = <span class="i">Fingerprints::FingerprintsStringUtil::GetFingeprintsStringDelimiter</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
988 975 | |
989 976 <span class="i">@Values</span> = <span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
990 977 <span class="k">for</span> <span class="i">$Key</span> <span class="s">(</span><span class="i">@Keys</span><span class="s">)</span> <span class="s">{</span> | |
991 978 <span class="k">push</span> <span class="i">@Values</span><span class="cm">,</span> <span class="i">$This</span>->{<span class="w">RequiredHeaderDataKeysAndValues</span>}{<span class="i">$Key</span>}<span class="sc">;</span> | |
992 979 <span class="s">}</span> | |
993 980 | |
994 981 <span class="k">return</span> <span class="k">join</span><span class="s">(</span><span class="i">$Delimiter</span><span class="cm">,</span> <span class="i">@Values</span><span class="s">)</span> | |
995 982 <span class="s">}</span> | |
996 983 | |
997 984 <span class="c"># Get required header data keys...</span> | |
998 985 <span class="c">#</span> | |
999 <a name="_GetRequiredHeaderDataKeys-"></a> 986 <span class="k">sub </span><span class="m">_GetRequiredHeaderDataKeys</span> <span class="s">{</span> | |
1000 987 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">$FingerprintsStringType</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
1001 988 <span class="k">my</span><span class="s">(</span><span class="i">@RequiredKeys</span><span class="s">)</span><span class="sc">;</span> | |
1002 989 | |
1003 990 <span class="i">@RequiredKeys</span> = <span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
1004 991 | |
1005 992 <span class="k">if</span> <span class="s">(</span><span class="i">$FingerprintsStringType</span> =~ <span class="q">/FingerprintsBitVector$/i</span><span class="s">)</span> <span class="s">{</span> | |
1006 993 <span class="k">push</span> <span class="i">@RequiredKeys</span><span class="cm">,</span> <span class="q">qw(FingerprintsStringType Description Size BitStringFormat BitsOrder)</span><span class="sc">;</span> | |
1007 994 <span class="s">}</span> | |
1008 995 <span class="k">elsif</span> <span class="s">(</span><span class="i">$FingerprintsStringType</span> =~ <span class="q">/^FingerprintsVector/i</span><span class="s">)</span> <span class="s">{</span> | |
1009 996 <span class="k">push</span> <span class="i">@RequiredKeys</span><span class="cm">,</span> <span class="q">qw(FingerprintsStringType Description VectorStringFormat VectorValuesType)</span><span class="sc">;</span> | |
1010 997 <span class="s">}</span> | |
1011 998 <span class="k">else</span> <span class="s">{</span> | |
1012 999 <span class="w">carp</span> <span class="q">"Warning: ${ClassName}->GetRequiredHeaderDataKeys: FingerprintsStringType value, $FingerprintsStringType, is not valid. Supported values: FingerprintsBitVector or FingerprintsVector..."</span><span class="sc">;</span> | |
1013 1000 <span class="s">}</span> | |
1014 1001 | |
1015 1002 <span class="k">return</span> <span class="i">@RequiredKeys</span><span class="sc">;</span> | |
1016 1003 <span class="s">}</span> | |
1017 1004 | |
1018 1005 <span class="c"># Validate fingerprints string mode information...</span> | |
1019 1006 <span class="c">#</span> | |
1020 <a name="_ValidateReadFingerprintsStringMode-"></a>1007 <span class="k">sub </span><span class="m">_ValidateReadFingerprintsStringMode</span> <span class="s">{</span> | |
1021 1008 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
1022 1009 <span class="k">my</span><span class="s">(</span><span class="i">$FingerprintsStringType</span><span class="cm">,</span> <span class="i">$FingerprintsStringDescription</span><span class="cm">,</span> <span class="i">$FingerprintsBitVectorStringMode</span><span class="cm">,</span> <span class="i">$FingerprintsVectorStringMode</span><span class="cm">,</span> <span class="i">$FirstFingerprintsStringType</span><span class="cm">,</span> <span class="i">$FirstFingerprintsStringDescription</span><span class="s">)</span><span class="sc">;</span> | |
1023 1010 | |
1024 1011 <span class="i">$This</span>->{<span class="w">ValidFingerprintsStringMode</span>} = <span class="n">0</span><span class="sc">;</span> | |
1025 1012 <span class="i">$This</span>->{<span class="w">FingerprintsBitVectorStringMode</span>} = <span class="n">0</span><span class="sc">;</span> | |
1026 1013 <span class="i">$This</span>->{<span class="w">FingerprintsVectorStringMode</span>} = <span class="n">0</span><span class="sc">;</span> | |
1027 1014 | |
1028 1015 <span class="i">$This</span>->{<span class="w">FirstFingerprintsStringType</span>} = <span class="q">''</span><span class="sc">;</span> | |
1029 1016 <span class="i">$This</span>->{<span class="w">FirstFingerprintsStringDescription</span>} = <span class="q">''</span><span class="sc">;</span> | |
1030 1017 | |
1031 1018 <span class="i">$FingerprintsBitVectorStringMode</span> = <span class="n">0</span><span class="sc">;</span> | |
1032 1019 <span class="i">$FingerprintsVectorStringMode</span> = <span class="n">0</span><span class="sc">;</span> | |
1033 1020 | |
1034 1021 <span class="i">$FirstFingerprintsStringType</span> = <span class="q">''</span><span class="sc">;</span> | |
1035 1022 <span class="i">$FirstFingerprintsStringDescription</span> = <span class="q">''</span><span class="sc">;</span> | |
1036 1023 | |
1037 1024 <span class="i">$FingerprintsStringType</span> = <span class="i">$This</span><span class="i">->GetHeaderDataKeyValue</span><span class="s">(</span><span class="q">'FingerprintsStringType'</span><span class="s">)</span><span class="sc">;</span> | |
1038 1025 <span class="i">$FingerprintsStringDescription</span> = <span class="i">$This</span><span class="i">->GetHeaderDataKeyValue</span><span class="s">(</span><span class="q">'Description'</span><span class="s">)</span><span class="sc">;</span> | |
1039 1026 | |
1040 1027 <span class="k">if</span> <span class="s">(</span><span class="i">$This</span>->{<span class="w">FingerprintsStringMode</span>} =~ <span class="q">/^FingerprintsBitVectorString$/i</span><span class="s">)</span> <span class="s">{</span> | |
1041 1028 <span class="k">if</span> <span class="s">(</span><span class="i">$FingerprintsStringType</span> !~ <span class="q">/^FingerprintsBitVector$/i</span><span class="s">)</span> <span class="s">{</span> | |
1042 1029 <span class="w">carp</span> <span class="q">"Warning: ${ClassName}->_ValidateReadFingerprintsStringMode: Fingerprints string data type, $FingerprintsStringType, doesn't correspond to, FingerprintsBitVectorString, specified using \"FingerprintsStringMode\"..."</span><span class="sc">;</span> | |
1043 1030 <span class="k">return</span> <span class="n">0</span><span class="sc">;</span> | |
1044 1031 <span class="s">}</span> | |
1045 1032 <span class="i">$FingerprintsBitVectorStringMode</span> = <span class="n">1</span><span class="sc">;</span> | |
1046 1033 <span class="i">$FirstFingerprintsStringType</span> = <span class="q">'FingerprintsBitVector'</span><span class="sc">;</span> | |
1047 1034 <span class="i">$FirstFingerprintsStringDescription</span> = <span class="i">$FingerprintsStringDescription</span><span class="sc">;</span> | |
1048 1035 <span class="s">}</span> | |
1049 1036 <span class="k">elsif</span> <span class="s">(</span><span class="i">$This</span>->{<span class="w">FingerprintsStringMode</span>} =~ <span class="q">/^FingerprintsVectorString$/i</span><span class="s">)</span> <span class="s">{</span> | |
1050 1037 <span class="k">if</span> <span class="s">(</span><span class="i">$FingerprintsStringType</span> !~ <span class="q">/^FingerprintsVector$/i</span><span class="s">)</span> <span class="s">{</span> | |
1051 1038 <span class="w">carp</span> <span class="q">"Warning: ${ClassName}->_ValidateReadFingerprintsStringMode: Fingerprints string data type, $FingerprintsStringType, doesn't correspond to, FingerprintsVectorString, specified using \"FingerprintsStringMode\"..."</span><span class="sc">;</span> | |
1052 1039 <span class="k">return</span> <span class="n">0</span><span class="sc">;</span> | |
1053 1040 <span class="s">}</span> | |
1054 1041 <span class="i">$FingerprintsVectorStringMode</span> = <span class="n">1</span><span class="sc">;</span> | |
1055 1042 <span class="i">$FirstFingerprintsStringType</span> = <span class="q">'FingerprintsVector'</span><span class="sc">;</span> | |
1056 1043 <span class="i">$FirstFingerprintsStringDescription</span> = <span class="i">$FingerprintsStringDescription</span><span class="sc">;</span> | |
1057 1044 <span class="s">}</span> | |
1058 1045 <span class="k">else</span> <span class="s">{</span> | |
1059 1046 <span class="c"># AutoDetect mode...</span> | |
1060 1047 <span class="k">if</span> <span class="s">(</span><span class="i">$FingerprintsStringType</span> =~ <span class="q">/^FingerprintsBitVector$/i</span><span class="s">)</span> <span class="s">{</span> | |
1061 1048 <span class="i">$FingerprintsBitVectorStringMode</span> = <span class="n">1</span><span class="sc">;</span> | |
1062 1049 <span class="s">}</span> | |
1063 1050 <span class="k">elsif</span> <span class="s">(</span><span class="i">$FingerprintsStringType</span> =~ <span class="q">/^FingerprintsVector$/i</span><span class="s">)</span> <span class="s">{</span> | |
1064 1051 <span class="i">$FingerprintsVectorStringMode</span> = <span class="n">1</span><span class="sc">;</span> | |
1065 1052 <span class="s">}</span> | |
1066 1053 <span class="k">else</span> <span class="s">{</span> | |
1067 1054 <span class="w">carp</span> <span class="q">"Warning: ${ClassName}->_ValidateReadFingerprintsStringMode: Fingerprints string data type, $FingerprintsStringType, identified during, AutoDetect, value of \"FingerprintsStringMode\" is not valid; Supported fingerprints types: FingerprintBitVector or FingerprintsVector..."</span><span class="sc">;</span> | |
1068 1055 <span class="k">return</span> <span class="n">0</span><span class="sc">;</span> | |
1069 1056 <span class="s">}</span> | |
1070 1057 <span class="i">$FirstFingerprintsStringType</span> = <span class="i">$FingerprintsStringType</span><span class="sc">;</span> | |
1071 1058 <span class="i">$FirstFingerprintsStringDescription</span> = <span class="i">$FingerprintsStringDescription</span><span class="sc">;</span> | |
1072 1059 <span class="s">}</span> | |
1073 1060 | |
1074 1061 <span class="i">$This</span>->{<span class="w">ValidFingerprintsStringMode</span>} = <span class="n">1</span><span class="sc">;</span> | |
1075 1062 | |
1076 1063 <span class="i">$This</span>->{<span class="w">FingerprintsBitVectorStringMode</span>} = <span class="i">$FingerprintsBitVectorStringMode</span><span class="sc">;</span> | |
1077 1064 <span class="i">$This</span>->{<span class="w">FingerprintsVectorStringMode</span>} = <span class="i">$FingerprintsVectorStringMode</span><span class="sc">;</span> | |
1078 1065 | |
1079 1066 <span class="i">$This</span>->{<span class="w">FirstFingerprintsStringType</span>} = <span class="i">$FirstFingerprintsStringType</span><span class="sc">;</span> | |
1080 1067 <span class="i">$This</span>->{<span class="w">FirstFingerprintsStringDescription</span>} = <span class="i">$FirstFingerprintsStringDescription</span><span class="sc">;</span> | |
1081 1068 | |
1082 1069 <span class="k">return</span> <span class="n">1</span><span class="sc">;</span> | |
1083 1070 <span class="s">}</span> | |
1084 1071 | |
1085 1072 <span class="c"># Write fingerprints string generated from specified fingerprints - fingerprints-bit vector or</span> | |
1086 1073 <span class="c"># fingerprints vector - object and other data to FP file...</span> | |
1087 1074 <span class="c">#</span> | |
1088 <a name="WriteFingerprints-"></a>1075 <span class="k">sub </span><span class="m">WriteFingerprints</span> <span class="s">{</span> | |
1089 1076 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">$FingerprintsObject</span><span class="cm">,</span> <span class="i">$CompoundID</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
1090 1077 | |
1091 1078 <span class="c"># Initialize data for current line...</span> | |
1092 1079 <span class="i">$This</span><span class="i">->_InitializeWriteDataLine</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
1093 1080 | |
1094 1081 <span class="c"># Set fingerprints object and compound ID...</span> | |
1095 1082 <span class="i">$This</span>->{<span class="w">FingerprintsObject</span>} = <span class="i">$FingerprintsObject</span><span class="sc">;</span> | |
1096 1083 <span class="i">$This</span><span class="i">->SetCompoundID</span><span class="s">(</span><span class="i">$CompoundID</span><span class="s">)</span><span class="sc">;</span> | |
1097 1084 | |
1098 1085 <span class="c"># Generate fingerprints string...</span> | |
1099 1086 <span class="i">$This</span><span class="i">->_GenerateFingerprintsString</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
1100 1087 | |
1101 1088 <span class="c"># Generate partial fingerprints string...</span> | |
1102 1089 <span class="i">$This</span><span class="i">->_GeneratePartialFingerprintsStringFromFingerprintsString</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
1103 1090 | |
1104 1091 <span class="c"># Write data line..</span> | |
1105 1092 <span class="i">$This</span><span class="i">->_WriteDataLine</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
1106 1093 | |
1107 1094 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
1108 1095 <span class="s">}</span> | |
1109 1096 | |
1110 1097 <span class="c"># Write fingerprints string and other data to FP file...</span> | |
1111 1098 <span class="c">#</span> | |
1112 1099 <span class="c"># Notes:</span> | |
1113 1100 <span class="c"># o FingerprintsStringMode, BitStringFormat, BitsOrder, VectorStringFormat values</span> | |
1114 1101 <span class="c"># are ignored during writing of fingerprints and it's written to the file as it is.</span> | |
1115 1102 <span class="c"># o FingerprintsString is a regular fingerprints string as oppose to a partial fingerprints</span> | |
1116 1103 <span class="c"># string.</span> | |
1117 1104 <span class="c">#</span> | |
1118 <a name="WriteFingerprintsString-"></a>1105 <span class="k">sub </span><span class="m">WriteFingerprintsString</span> <span class="s">{</span> | |
1119 1106 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">$FingerprintsString</span><span class="cm">,</span> <span class="i">$CompoundID</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
1120 1107 | |
1121 1108 <span class="c"># Initialize data for current line...</span> | |
1122 1109 <span class="i">$This</span><span class="i">->_InitializeWriteDataLine</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
1123 1110 | |
1124 1111 <span class="c"># Set fingerprints string and compound ID...</span> | |
1125 1112 <span class="i">$This</span>->{<span class="w">FingerprintsString</span>} = <span class="i">$FingerprintsString</span><span class="sc">;</span> | |
1126 1113 <span class="i">$This</span><span class="i">->SetCompoundID</span><span class="s">(</span><span class="i">$CompoundID</span><span class="s">)</span><span class="sc">;</span> | |
1127 1114 | |
1128 1115 <span class="c"># Generate fingerprints object...</span> | |
1129 1116 <span class="i">$This</span><span class="i">->_GenerateFingerprintsObject</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
1130 1117 | |
1131 1118 <span class="c"># Generate partial fingerprints string...</span> | |
1132 1119 <span class="i">$This</span><span class="i">->_GeneratePartialFingerprintsStringFromFingerprintsString</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
1133 1120 | |
1134 1121 <span class="c"># Write data line..</span> | |
1135 1122 <span class="i">$This</span><span class="i">->_WriteDataLine</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
1136 1123 | |
1137 1124 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
1138 1125 <span class="s">}</span> | |
1139 1126 | |
1140 1127 <span class="c"># Initialize data line for reading...</span> | |
1141 1128 <span class="c">#</span> | |
1142 <a name="_InitializeWriteDataLine-"></a>1129 <span class="k">sub </span><span class="m">_InitializeWriteDataLine</span> <span class="s">{</span> | |
1143 1130 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
1144 1131 | |
1145 1132 <span class="i">$This</span>->{<span class="w">DataLine</span>} = <span class="k">undef</span><span class="sc">;</span> | |
1146 1133 <span class="i">$This</span>->{<span class="w">CompoundID</span>} = <span class="k">undef</span><span class="sc">;</span> | |
1147 1134 | |
1148 1135 <span class="i">$This</span>->{<span class="w">FingerprintsObject</span>} = <span class="k">undef</span><span class="sc">;</span> | |
1149 1136 | |
1150 1137 <span class="i">$This</span>->{<span class="w">FingerprintsString</span>} = <span class="k">undef</span><span class="sc">;</span> | |
1151 1138 <span class="i">$This</span>->{<span class="w">PartialFingerprintsString</span>} = <span class="k">undef</span><span class="sc">;</span> | |
1152 1139 | |
1153 1140 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
1154 1141 <span class="s">}</span> | |
1155 1142 | |
1156 1143 <span class="c"># Write fingerprints data line line...</span> | |
1157 1144 <span class="c">#</span> | |
1158 <a name="_WriteDataLine-"></a>1145 <span class="k">sub </span><span class="m">_WriteDataLine</span> <span class="s">{</span> | |
1159 1146 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
1160 1147 <span class="k">my</span><span class="s">(</span><span class="i">$FileHandle</span><span class="cm">,</span> <span class="i">$Line</span><span class="s">)</span><span class="sc">;</span> | |
1161 1148 | |
1162 1149 <span class="k">if</span> <span class="s">(</span><span class="i">$This</span>->{<span class="w">FirstDataLineIO</span>}<span class="s">)</span> <span class="s">{</span> | |
1163 1150 <span class="i">$This</span><span class="i">->_ProcessFirstDataLineWrite</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
1164 1151 <span class="s">}</span> | |
1165 1152 | |
1166 1153 <span class="c"># Write data compound ID along with partial fingerprints string...</span> | |
1167 1154 <span class="i">$Line</span> = <span class="i">$This</span>->{<span class="w">CompoundID</span>} . <span class="q">' '</span> . <span class="i">$This</span>->{<span class="w">PartialFingerprintsString</span>}<span class="sc">;</span> | |
1168 1155 | |
1169 1156 <span class="i">$This</span>->{<span class="w">LineNum</span>} += <span class="n">1</span><span class="sc">;</span> | |
1170 1157 <span class="i">$FileHandle</span> = <span class="i">$This</span>->{<span class="w">FileHandle</span>}<span class="sc">;</span> | |
1171 1158 <span class="k">print</span> <span class="i">$FileHandle</span> <span class="q">"$Line\n"</span><span class="sc">;</span> | |
1172 1159 | |
1173 1160 <span class="i">$This</span>->{<span class="w">DataLine</span>} = <span class="i">$Line</span><span class="sc">;</span> | |
1174 1161 | |
1175 1162 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
1176 1163 <span class="s">}</span> | |
1177 1164 | |
1178 1165 <span class="c"># Process first write...</span> | |
1179 1166 <span class="c">#</span> | |
1180 <a name="_ProcessFirstDataLineWrite-"></a>1167 <span class="k">sub </span><span class="m">_ProcessFirstDataLineWrite</span> <span class="s">{</span> | |
1181 1168 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
1182 1169 <span class="k">my</span><span class="s">(</span><span class="i">$Line</span><span class="cm">,</span> <span class="i">$FileHandle</span><span class="s">)</span><span class="sc">;</span> | |
1183 1170 | |
1184 1171 <span class="i">$This</span>->{<span class="w">FirstDataLineIO</span>} = <span class="n">0</span><span class="sc">;</span> | |
1185 1172 | |
1186 1173 <span class="k">if</span> <span class="s">(</span><span class="i">$This</span><span class="i">->GetMode</span><span class="s">(</span><span class="s">)</span> =~ <span class="q">/^Write$/i</span><span class="s">)</span> <span class="s">{</span> | |
1187 1174 <span class="c"># Skip it for append mode...</span> | |
1188 1175 <span class="i">$This</span><span class="i">->_WritePackageAndTimeStampHeaderKeys</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
1189 1176 <span class="i">$This</span><span class="i">->_WriteRequiredHeaderDataKeys</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
1190 1177 <span class="s">}</span> | |
1191 1178 | |
1192 1179 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
1193 1180 <span class="s">}</span> | |
1194 1181 | |
1195 1182 <span class="c"># Write out package and time stamp information...</span> | |
1196 1183 <span class="c">#</span> | |
1197 <a name="_WritePackageAndTimeStampHeaderKeys-"></a>1184 <span class="k">sub </span><span class="m">_WritePackageAndTimeStampHeaderKeys</span> <span class="s">{</span> | |
1198 1185 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
1199 1186 <span class="k">my</span><span class="s">(</span><span class="i">$FileHandle</span><span class="cm">,</span> <span class="i">$Key</span><span class="cm">,</span> <span class="i">$Value</span><span class="s">)</span><span class="sc">;</span> | |
1200 1187 | |
1201 1188 <span class="i">$FileHandle</span> = <span class="i">$This</span>->{<span class="w">FileHandle</span>}<span class="sc">;</span> | |
1202 1189 | |
1203 1190 <span class="c"># Package information...</span> | |
1204 1191 <span class="i">$This</span>->{<span class="w">LineNum</span>} += <span class="n">1</span><span class="sc">;</span> | |
1205 1192 <span class="i">$Key</span> = <span class="q">"Package"</span><span class="sc">;</span> <span class="i">$Value</span> = <span class="i">PackageInfo::GetPackageName</span><span class="s">(</span><span class="s">)</span> . <span class="q">" "</span> . <span class="i">PackageInfo::GetVersionNumber</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
1206 1193 <span class="k">print</span> <span class="i">$FileHandle</span> <span class="q">"# $Key = $Value\n"</span><span class="sc">;</span> | |
1207 1194 | |
1208 1195 <span class="i">$This</span>->{<span class="w">LineNum</span>} += <span class="n">1</span><span class="sc">;</span> | |
1209 1196 <span class="i">$Key</span> = <span class="q">"Release Date"</span><span class="sc">;</span> <span class="i">$Value</span> = <span class="i">PackageInfo::GetReleaseDate</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
1210 1197 <span class="k">print</span> <span class="i">$FileHandle</span> <span class="q">"# $Key = $Value\n"</span><span class="sc">;</span> | |
1211 1198 | |
1212 1199 <span class="c"># Timestamp information...</span> | |
1213 1200 <span class="i">$This</span>->{<span class="w">LineNum</span>} += <span class="n">1</span><span class="sc">;</span> | |
1214 1201 <span class="k">print</span> <span class="i">$FileHandle</span> <span class="q">"#\n"</span><span class="sc">;</span> | |
1215 1202 | |
1216 1203 <span class="i">$This</span>->{<span class="w">LineNum</span>} += <span class="n">1</span><span class="sc">;</span> | |
1217 1204 <span class="i">$Key</span> = <span class="q">"TimeStamp"</span><span class="sc">;</span> <span class="i">$Value</span> = <span class="i">TimeUtil::FPFileTimeStamp</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
1218 1205 <span class="k">print</span> <span class="i">$FileHandle</span> <span class="q">"# $Key = $Value\n"</span><span class="sc">;</span> | |
1219 1206 | |
1220 1207 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
1221 1208 <span class="s">}</span> | |
1222 1209 | |
1223 1210 <span class="c"># Write out required header data keys...</span> | |
1224 1211 <span class="c">#</span> | |
1225 <a name="_WriteRequiredHeaderDataKeys-"></a>1212 <span class="k">sub </span><span class="m">_WriteRequiredHeaderDataKeys</span> <span class="s">{</span> | |
1226 1213 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
1227 1214 <span class="k">my</span><span class="s">(</span><span class="i">$FileHandle</span><span class="cm">,</span> <span class="i">$Key</span><span class="cm">,</span> <span class="i">$Value</span><span class="s">)</span><span class="sc">;</span> | |
1228 1215 | |
1229 1216 <span class="i">$FileHandle</span> = <span class="i">$This</span>->{<span class="w">FileHandle</span>}<span class="sc">;</span> | |
1230 1217 | |
1231 1218 <span class="i">$This</span><span class="i">->_GenerateWriteRequiredHeaderDataKeys</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
1232 1219 | |
1233 1220 <span class="i">$This</span>->{<span class="w">LineNum</span>} += <span class="n">1</span><span class="sc">;</span> | |
1234 1221 <span class="k">print</span> <span class="i">$FileHandle</span> <span class="q">"#\n"</span><span class="sc">;</span> | |
1235 1222 | |
1236 1223 <span class="k">for</span> <span class="i">$Key</span> <span class="s">(</span><span class="i">@</span>{<span class="i">$This</span>->{<span class="w">RequiredHeaderDataKeys</span>}}<span class="s">)</span> <span class="s">{</span> | |
1237 1224 <span class="i">$Value</span> = <span class="i">$This</span>->{<span class="w">RequiredHeaderDataKeysAndValues</span>}{<span class="i">$Key</span>}<span class="sc">;</span> | |
1238 1225 | |
1239 1226 <span class="i">$This</span>->{<span class="w">LineNum</span>} += <span class="n">1</span><span class="sc">;</span> | |
1240 1227 <span class="k">print</span> <span class="i">$FileHandle</span> <span class="q">"# $Key = $Value\n"</span><span class="sc">;</span> | |
1241 1228 | |
1242 1229 <span class="k">if</span> <span class="s">(</span><span class="i">$Key</span> =~ <span class="q">/^FingerprintsStringType$/i</span><span class="s">)</span> <span class="s">{</span> | |
1243 1230 <span class="i">$This</span>->{<span class="w">LineNum</span>} += <span class="n">1</span><span class="sc">;</span> | |
1244 1231 <span class="k">print</span> <span class="i">$FileHandle</span> <span class="q">"#\n"</span><span class="sc">;</span> | |
1245 1232 <span class="s">}</span> | |
1246 1233 <span class="s">}</span> | |
1247 1234 | |
1248 1235 <span class="i">$This</span>->{<span class="w">LineNum</span>} += <span class="n">1</span><span class="sc">;</span> | |
1249 1236 <span class="k">print</span> <span class="i">$FileHandle</span> <span class="q">"#\n"</span><span class="sc">;</span> | |
1250 1237 | |
1251 1238 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
1252 1239 <span class="s">}</span> | |
1253 1240 | |
1254 <a name="_GenerateWriteRequiredHeaderDataKeys-"></a>1241 <span class="k">sub </span><span class="m">_GenerateWriteRequiredHeaderDataKeys</span> <span class="s">{</span> | |
1255 1242 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
1256 1243 | |
1257 1244 <span class="k">if</span> <span class="s">(</span><span class="i">$This</span>->{<span class="w">FingerprintsBitVectorStringMode</span>} && <span class="s">(</span><span class="i">$This</span>->{<span class="w">FingerprintsString</span>} =~ <span class="q">/^FingerprintsBitVector/i</span><span class="s">)</span><span class="s">)</span> <span class="s">{</span> | |
1258 1245 <span class="i">$This</span><span class="i">->_GenerateWriteRequiredHeaderDataKeysForBitVectorString</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
1259 1246 <span class="s">}</span> | |
1260 1247 <span class="k">elsif</span> <span class="s">(</span><span class="i">$This</span>->{<span class="w">FingerprintsVectorStringMode</span>} && <span class="s">(</span><span class="i">$This</span>->{<span class="w">FingerprintsString</span>} =~ <span class="q">/^FingerprintsVector/i</span><span class="s">)</span><span class="s">)</span> <span class="s">{</span> | |
1261 1248 <span class="i">$This</span><span class="i">->_GenerateWriteRequiredHeaderDataKeysForVectorString</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
1262 1249 <span class="s">}</span> | |
1263 1250 <span class="k">else</span> <span class="s">{</span> | |
1264 1251 <span class="w">croak</span> <span class="q">"Error: ${ClassName}->_GenerateWriteRequiredHeaderDataKeys: Required header data keys can't be generated: FingerprintsStringMode value, $This->{FingerprintsStringMode}, doesn't correspond to type of first FingerprintsString: $This->{FingerprintsString}..."</span><span class="sc">;</span> | |
1265 1252 <span class="s">}</span> | |
1266 1253 | |
1267 1254 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
1268 1255 <span class="s">}</span> | |
1269 1256 | |
1270 1257 <span class="c"># Generate required data header keys and values for writing fingerprints bit vector string...</span> | |
1271 1258 <span class="c">#</span> | |
1272 <a name="_GenerateWriteRequiredHeaderDataKeysForBitVectorString-"></a>1259 <span class="k">sub </span><span class="m">_GenerateWriteRequiredHeaderDataKeysForBitVectorString</span> <span class="s">{</span> | |
1273 1260 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
1274 1261 <span class="k">my</span><span class="s">(</span><span class="i">$Key</span><span class="cm">,</span> <span class="i">$VectorType</span><span class="cm">,</span> <span class="i">$Description</span><span class="cm">,</span> <span class="i">$Size</span><span class="cm">,</span> <span class="i">$BitStringFormat</span><span class="cm">,</span> <span class="i">$BitsOrder</span><span class="s">)</span><span class="sc">;</span> | |
1275 1262 | |
1276 1263 <span class="i">@</span>{<span class="i">$This</span>->{<span class="w">RequiredHeaderDataKeys</span>}} = <span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
1277 1264 <span class="k">push</span> <span class="i">@</span>{<span class="i">$This</span>->{<span class="w">RequiredHeaderDataKeys</span>}}<span class="cm">,</span> <span class="i">$This</span><span class="i">->_GetRequiredHeaderDataKeys</span><span class="s">(</span><span class="q">'FingerprintsBitVector'</span><span class="s">)</span><span class="sc">;</span> | |
1278 1265 | |
1279 1266 <span class="s">(</span><span class="i">$VectorType</span><span class="cm">,</span> <span class="i">$Description</span><span class="cm">,</span> <span class="i">$Size</span><span class="cm">,</span> <span class="i">$BitStringFormat</span><span class="cm">,</span> <span class="i">$BitsOrder</span><span class="s">)</span> = <span class="i">Fingerprints::FingerprintsStringUtil::GetFingerprintsStringValues</span><span class="s">(</span><span class="i">$This</span>->{<span class="w">FingerprintsString</span>}<span class="s">)</span><span class="sc">;</span> | |
1280 1267 | |
1281 1268 <span class="i">%</span>{<span class="i">$This</span>->{<span class="w">RequiredHeaderDataKeysAndValues</span>}} = <span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
1282 1269 | |
1283 1270 <span class="k">for</span> <span class="i">$Key</span> <span class="s">(</span><span class="i">@</span>{<span class="i">$This</span>->{<span class="w">RequiredHeaderDataKeys</span>}}<span class="s">)</span> <span class="s">{</span> | |
1284 1271 <span class="j">KEYTYPE:</span> <span class="s">{</span> | |
1285 1272 <span class="k">if</span> <span class="s">(</span><span class="i">$Key</span> =~ <span class="q">/^FingerprintsStringType$/i</span><span class="s">)</span> <span class="s">{</span> | |
1286 1273 <span class="i">$This</span>->{<span class="w">RequiredHeaderDataKeysAndValues</span>}{<span class="i">$Key</span>} = <span class="i">$VectorType</span><span class="sc">;</span> | |
1287 1274 <span class="k">last</span> <span class="j">KEYTYPE</span><span class="sc">;</span> | |
1288 1275 <span class="s">}</span> | |
1289 1276 <span class="k">if</span> <span class="s">(</span><span class="i">$Key</span> =~ <span class="q">/^Description$/i</span><span class="s">)</span> <span class="s">{</span> | |
1290 1277 <span class="i">$This</span>->{<span class="w">RequiredHeaderDataKeysAndValues</span>}{<span class="i">$Key</span>} = <span class="i">$Description</span><span class="sc">;</span> | |
1291 1278 <span class="k">last</span> <span class="j">KEYTYPE</span><span class="sc">;</span> | |
1292 1279 <span class="s">}</span> | |
1293 1280 <span class="k">if</span> <span class="s">(</span><span class="i">$Key</span> =~ <span class="q">/^Size$/i</span><span class="s">)</span> <span class="s">{</span> | |
1294 1281 <span class="i">$This</span>->{<span class="w">RequiredHeaderDataKeysAndValues</span>}{<span class="i">$Key</span>} = <span class="i">$Size</span><span class="sc">;</span> | |
1295 1282 <span class="k">last</span> <span class="j">KEYTYPE</span><span class="sc">;</span> | |
1296 1283 <span class="s">}</span> | |
1297 1284 <span class="k">if</span> <span class="s">(</span><span class="i">$Key</span> =~ <span class="q">/^BitStringFormat$/i</span><span class="s">)</span> <span class="s">{</span> | |
1298 1285 <span class="i">$This</span>->{<span class="w">RequiredHeaderDataKeysAndValues</span>}{<span class="i">$Key</span>} = <span class="i">$BitStringFormat</span><span class="sc">;</span> | |
1299 1286 <span class="k">last</span> <span class="j">KEYTYPE</span><span class="sc">;</span> | |
1300 1287 <span class="s">}</span> | |
1301 1288 <span class="k">if</span> <span class="s">(</span><span class="i">$Key</span> =~ <span class="q">/^BitsOrder$/i</span><span class="s">)</span> <span class="s">{</span> | |
1302 1289 <span class="i">$This</span>->{<span class="w">RequiredHeaderDataKeysAndValues</span>}{<span class="i">$Key</span>} = <span class="i">$BitsOrder</span><span class="sc">;</span> | |
1303 1290 <span class="k">last</span> <span class="j">KEYTYPE</span><span class="sc">;</span> | |
1304 1291 <span class="s">}</span> | |
1305 1292 <span class="w">croak</span> <span class="q">"Error: ${ClassName}->_GenerateWriteRequiredHeaderDataKeysForBitVectorString: Required header data key, $Key, value can't be generated: It's not a known key ..."</span><span class="sc">;</span> | |
1306 1293 <span class="s">}</span> | |
1307 1294 <span class="s">}</span> | |
1308 1295 | |
1309 1296 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
1310 1297 <span class="s">}</span> | |
1311 1298 | |
1312 1299 <span class="c"># Generate required data header keys and values for writing fingerprints vector string...</span> | |
1313 1300 <span class="c">#</span> | |
1314 <a name="_GenerateWriteRequiredHeaderDataKeysForVectorString-"></a>1301 <span class="k">sub </span><span class="m">_GenerateWriteRequiredHeaderDataKeysForVectorString</span> <span class="s">{</span> | |
1315 1302 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
1316 1303 <span class="k">my</span><span class="s">(</span><span class="i">$Key</span><span class="cm">,</span> <span class="i">$Value</span><span class="cm">,</span> <span class="i">$VectorType</span><span class="cm">,</span> <span class="i">$Description</span><span class="cm">,</span> <span class="i">$NumOfValues</span><span class="cm">,</span> <span class="i">$VectorValuesType</span><span class="cm">,</span> <span class="i">$VectorStringFormat</span><span class="s">)</span><span class="sc">;</span> | |
1317 1304 | |
1318 1305 <span class="i">@</span>{<span class="i">$This</span>->{<span class="w">RequiredHeaderDataKeys</span>}} = <span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
1319 1306 <span class="k">push</span> <span class="i">@</span>{<span class="i">$This</span>->{<span class="w">RequiredHeaderDataKeys</span>}}<span class="cm">,</span> <span class="i">$This</span><span class="i">->_GetRequiredHeaderDataKeys</span><span class="s">(</span><span class="q">'FingerprintsVector'</span><span class="s">)</span><span class="sc">;</span> | |
1320 1307 | |
1321 1308 <span class="s">(</span><span class="i">$VectorType</span><span class="cm">,</span> <span class="i">$Description</span><span class="cm">,</span> <span class="i">$NumOfValues</span><span class="cm">,</span> <span class="i">$VectorValuesType</span><span class="cm">,</span> <span class="i">$VectorStringFormat</span><span class="s">)</span> = <span class="i">Fingerprints::FingerprintsStringUtil::GetFingerprintsStringValues</span><span class="s">(</span><span class="i">$This</span>->{<span class="w">FingerprintsString</span>}<span class="s">)</span><span class="sc">;</span> | |
1322 1309 | |
1323 1310 <span class="i">%</span>{<span class="i">$This</span>->{<span class="w">RequiredHeaderDataKeysAndValues</span>}} = <span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
1324 1311 | |
1325 1312 <span class="k">for</span> <span class="i">$Key</span> <span class="s">(</span><span class="i">@</span>{<span class="i">$This</span>->{<span class="w">RequiredHeaderDataKeys</span>}}<span class="s">)</span> <span class="s">{</span> | |
1326 1313 <span class="j">KEYTYPE:</span> <span class="s">{</span> | |
1327 1314 <span class="k">if</span> <span class="s">(</span><span class="i">$Key</span> =~ <span class="q">/^FingerprintsStringType$/i</span><span class="s">)</span> <span class="s">{</span> | |
1328 1315 <span class="i">$This</span>->{<span class="w">RequiredHeaderDataKeysAndValues</span>}{<span class="i">$Key</span>} = <span class="i">$VectorType</span><span class="sc">;</span> | |
1329 1316 <span class="k">last</span> <span class="j">KEYTYPE</span><span class="sc">;</span> | |
1330 1317 <span class="s">}</span> | |
1331 1318 <span class="k">if</span> <span class="s">(</span><span class="i">$Key</span> =~ <span class="q">/^Description$/i</span><span class="s">)</span> <span class="s">{</span> | |
1332 1319 <span class="i">$This</span>->{<span class="w">RequiredHeaderDataKeysAndValues</span>}{<span class="i">$Key</span>} = <span class="i">$Description</span><span class="sc">;</span> | |
1333 1320 <span class="k">last</span> <span class="j">KEYTYPE</span><span class="sc">;</span> | |
1334 1321 <span class="s">}</span> | |
1335 1322 <span class="k">if</span> <span class="s">(</span><span class="i">$Key</span> =~ <span class="q">/^VectorValuesType$/i</span><span class="s">)</span> <span class="s">{</span> | |
1336 1323 <span class="i">$This</span>->{<span class="w">RequiredHeaderDataKeysAndValues</span>}{<span class="i">$Key</span>} = <span class="i">$VectorValuesType</span><span class="sc">;</span> | |
1337 1324 <span class="k">last</span> <span class="j">KEYTYPE</span><span class="sc">;</span> | |
1338 1325 <span class="s">}</span> | |
1339 1326 <span class="k">if</span> <span class="s">(</span><span class="i">$Key</span> =~ <span class="q">/^VectorStringFormat$/i</span><span class="s">)</span> <span class="s">{</span> | |
1340 1327 <span class="i">$This</span>->{<span class="w">RequiredHeaderDataKeysAndValues</span>}{<span class="i">$Key</span>} = <span class="i">$VectorStringFormat</span><span class="sc">;</span> | |
1341 1328 <span class="k">last</span> <span class="j">KEYTYPE</span><span class="sc">;</span> | |
1342 1329 <span class="s">}</span> | |
1343 1330 <span class="w">croak</span> <span class="q">"Error: ${ClassName}->_GenerateWriteRequiredHeaderDataKeysForVectorString: Required header data key, $Key, value can't be generated: It's not a known key ..."</span><span class="sc">;</span> | |
1344 1331 <span class="s">}</span> | |
1345 1332 <span class="s">}</span> | |
1346 1333 | |
1347 1334 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
1348 1335 <span class="s">}</span> | |
1349 1336 | |
1350 1337 | |
1351 1338 <span class="c"># Get ready for writing fingerprints FP file...</span> | |
1352 1339 <span class="c">#</span> | |
1353 <a name="_PrepareForWritingFingerprintsFPFileData-"></a>1340 <span class="k">sub </span><span class="m">_PrepareForWritingFingerprintsFPFileData</span> <span class="s">{</span> | |
1354 1341 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
1355 1342 <span class="k">my</span><span class="s">(</span><span class="i">$FPFile</span><span class="cm">,</span> <span class="i">$FileDir</span><span class="cm">,</span> <span class="i">$FileName</span><span class="cm">,</span> <span class="i">$FileExt</span><span class="cm">,</span> <span class="i">$OutDelim</span><span class="s">)</span><span class="sc">;</span> | |
1356 1343 | |
1357 1344 <span class="i">$FPFile</span> = <span class="i">$This</span>->{<span class="w">Name</span>}<span class="sc">;</span> | |
1358 1345 <span class="k">if</span> <span class="s">(</span>!<span class="i">$This</span>->{<span class="w">Overwrite</span>}<span class="s">)</span> <span class="s">{</span> | |
1359 1346 <span class="k">if</span> <span class="s">(</span><span class="k">-e</span> <span class="i">$FPFile</span><span class="s">)</span> <span class="s">{</span> | |
1360 1347 <span class="w">croak</span> <span class="q">"Error: ${ClassName}->_PrepareForWritingFingerprintsFPFileData: File, $FPFile, already exist. Use overwrite option..."</span><span class="sc">;</span> | |
1361 1348 <span class="s">}</span> | |
1362 1349 <span class="s">}</span> | |
1363 1350 | |
1364 1351 <span class="c"># Setup FingerprintsStringMode status...</span> | |
1365 1352 <span class="c">#</span> | |
1366 1353 <span class="i">$This</span>->{<span class="w">FingerprintsBitVectorStringMode</span>} = <span class="n">0</span><span class="sc">;</span> | |
1367 1354 <span class="i">$This</span>->{<span class="w">FingerprintsVectorStringMode</span>} = <span class="n">0</span><span class="sc">;</span> | |
1368 1355 <span class="i">$This</span>->{<span class="w">ValidFingerprintsStringMode</span>} = <span class="n">0</span><span class="sc">;</span> | |
1369 1356 | |
1370 1357 <span class="k">if</span> <span class="s">(</span><span class="i">$This</span>->{<span class="w">FingerprintsStringMode</span>} =~ <span class="q">/^FingerprintsBitVectorString$/i</span><span class="s">)</span> <span class="s">{</span> | |
1371 1358 <span class="i">$This</span>->{<span class="w">FingerprintsBitVectorStringMode</span>} = <span class="n">1</span><span class="sc">;</span> | |
1372 1359 <span class="s">}</span> | |
1373 1360 <span class="k">elsif</span> <span class="s">(</span><span class="i">$This</span>->{<span class="w">FingerprintsStringMode</span>} =~ <span class="q">/^FingerprintsVectorString$/i</span><span class="s">)</span> <span class="s">{</span> | |
1374 1361 <span class="i">$This</span>->{<span class="w">FingerprintsVectorStringMode</span>} = <span class="n">1</span><span class="sc">;</span> | |
1375 1362 <span class="s">}</span> | |
1376 1363 | |
1377 1364 <span class="i">$This</span>->{<span class="w">ValidFingerprintsStringMode</span>} = <span class="s">(</span><span class="i">$This</span>->{<span class="w">FingerprintsBitVectorStringMode</span>} || <span class="i">$This</span>->{<span class="w">FingerprintsVectorStringMode</span>}<span class="s">)</span> ? <span class="n">1</span> <span class="co">:</span> <span class="n">0</span><span class="sc">;</span> | |
1378 1365 | |
1379 1366 <span class="k">if</span> <span class="s">(</span><span class="i">$This</span>->{<span class="w">FingerprintsBitVectorStringMode</span>}<span class="s">)</span> <span class="s">{</span> | |
1380 1367 <span class="i">$This</span><span class="i">->_SetDefaultBitStringFormat</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
1381 1368 <span class="i">$This</span><span class="i">->_SetDefaultBitsOrder</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
1382 1369 <span class="s">}</span> | |
1383 1370 <span class="k">elsif</span> <span class="s">(</span><span class="i">$This</span>->{<span class="w">FingerprintsVectorStringMode</span>}<span class="s">)</span> <span class="s">{</span> | |
1384 1371 <span class="i">$This</span><span class="i">->_SetDefaultVectorStringFormat</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
1385 1372 <span class="s">}</span> | |
1386 1373 | |
1387 1374 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
1388 1375 <span class="s">}</span> | |
1389 1376 | |
1390 1377 <span class="c"># Set default value for bit string format...</span> | |
1391 1378 <span class="c">#</span> | |
1392 <a name="_SetDefaultBitStringFormat-"></a>1379 <span class="k">sub </span><span class="m">_SetDefaultBitStringFormat</span> <span class="s">{</span> | |
1393 1380 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
1394 1381 | |
1395 1382 <span class="k">if</span> <span class="s">(</span>!<span class="i">$This</span>->{<span class="w">BitStringFormat</span>}<span class="s">)</span> <span class="s">{</span> | |
1396 1383 <span class="i">$This</span>->{<span class="w">BitStringFormat</span>} = <span class="i">Fingerprints::FingerprintsStringUtil::GetDefaultBitStringFormat</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
1397 1384 <span class="s">}</span> | |
1398 1385 | |
1399 1386 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
1400 1387 <span class="s">}</span> | |
1401 1388 | |
1402 1389 <span class="c"># Set default value for bit string format...</span> | |
1403 1390 <span class="c">#</span> | |
1404 <a name="_SetDefaultBitsOrder-"></a>1391 <span class="k">sub </span><span class="m">_SetDefaultBitsOrder</span> <span class="s">{</span> | |
1405 1392 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
1406 1393 | |
1407 1394 <span class="k">if</span> <span class="s">(</span>!<span class="i">$This</span>->{<span class="w">BitsOrder</span>}<span class="s">)</span> <span class="s">{</span> | |
1408 1395 <span class="i">$This</span>->{<span class="w">BitsOrder</span>} = <span class="i">Fingerprints::FingerprintsStringUtil::GetDefaultBitsOrder</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
1409 1396 <span class="s">}</span> | |
1410 1397 | |
1411 1398 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
1412 1399 <span class="s">}</span> | |
1413 1400 | |
1414 1401 <span class="c"># Set default value for vector string format...</span> | |
1415 1402 <span class="c">#</span> | |
1416 <a name="_SetDefaultVectorStringFormat-"></a>1403 <span class="k">sub </span><span class="m">_SetDefaultVectorStringFormat</span> <span class="s">{</span> | |
1417 1404 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
1418 1405 | |
1419 1406 <span class="k">if</span> <span class="s">(</span>!<span class="i">$This</span>->{<span class="w">VectorStringFormat</span>} && <span class="i">$This</span>->{<span class="w">FingerprintsObject</span>}<span class="s">)</span> <span class="s">{</span> | |
1420 1407 <span class="i">$This</span>->{<span class="w">VectorStringFormat</span>} = <span class="i">Fingerprints::FingerprintsStringUtil::GetDefaultVectorStringFormat</span><span class="s">(</span><span class="i">$This</span>->{<span class="w">FingerprintsObject</span>}<span class="s">)</span><span class="sc">;</span> | |
1421 1408 <span class="s">}</span> | |
1422 1409 | |
1423 1410 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
1424 1411 <span class="s">}</span> | |
1425 1412 | |
1426 1413 <span class="c"># Generate fingerprints object using current fingerprints string...</span> | |
1427 1414 <span class="c">#</span> | |
1428 <a name="_GenerateFingerprintsObject-"></a>1415 <span class="k">sub </span><span class="m">_GenerateFingerprintsObject</span> <span class="s">{</span> | |
1429 1416 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
1430 1417 | |
1431 1418 <span class="i">$This</span>->{<span class="w">FingerprintsObject</span>} = <span class="k">undef</span><span class="sc">;</span> | |
1432 1419 | |
1433 1420 <span class="k">if</span> <span class="s">(</span>!<span class="i">$This</span>->{<span class="w">FingerprintsString</span>}<span class="s">)</span> <span class="s">{</span> | |
1434 1421 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
1435 1422 <span class="s">}</span> | |
1436 1423 | |
1437 1424 <span class="k">if</span> <span class="s">(</span><span class="i">$This</span>->{<span class="w">FingerprintsBitVectorStringMode</span>}<span class="s">)</span> <span class="s">{</span> | |
1438 1425 <span class="i">$This</span>->{<span class="w">FingerprintsObject</span>} = <span class="i">Fingerprints::FingerprintsStringUtil::ParseFingerprintsBitVectorString</span><span class="s">(</span><span class="i">$This</span>->{<span class="w">FingerprintsString</span>}<span class="s">)</span><span class="sc">;</span> | |
1439 1426 <span class="s">}</span> | |
1440 1427 <span class="k">elsif</span> <span class="s">(</span><span class="i">$This</span>->{<span class="w">FingerprintsVectorStringMode</span>}<span class="s">)</span> <span class="s">{</span> | |
1441 1428 <span class="i">$This</span>->{<span class="w">FingerprintsObject</span>} = <span class="i">Fingerprints::FingerprintsStringUtil::ParseFingerprintsVectorString</span><span class="s">(</span><span class="i">$This</span>->{<span class="w">FingerprintsString</span>}<span class="s">)</span><span class="sc">;</span> | |
1442 1429 <span class="s">}</span> | |
1443 1430 <span class="k">else</span> <span class="s">{</span> | |
1444 1431 <span class="k">return</span> <span class="k">undef</span><span class="sc">;</span> | |
1445 1432 <span class="s">}</span> | |
1446 1433 | |
1447 1434 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
1448 1435 <span class="s">}</span> | |
1449 1436 | |
1450 1437 <span class="c"># Generate fingerprints string using current fingerprints object...</span> | |
1451 1438 <span class="c">#</span> | |
1452 <a name="_GenerateFingerprintsString-"></a>1439 <span class="k">sub </span><span class="m">_GenerateFingerprintsString</span> <span class="s">{</span> | |
1453 1440 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
1454 1441 | |
1455 1442 <span class="i">$This</span>->{<span class="w">FingerprintsString</span>} = <span class="q">''</span><span class="sc">;</span> | |
1456 1443 | |
1457 1444 <span class="k">if</span> <span class="s">(</span>!<span class="i">$This</span>->{<span class="w">FingerprintsObject</span>}<span class="s">)</span> <span class="s">{</span> | |
1458 1445 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
1459 1446 <span class="s">}</span> | |
1460 1447 | |
1461 1448 <span class="k">if</span> <span class="s">(</span><span class="i">$This</span>->{<span class="w">FingerprintsBitVectorStringMode</span>}<span class="s">)</span> <span class="s">{</span> | |
1462 1449 <span class="i">$This</span>->{<span class="w">FingerprintsString</span>} = <span class="i">Fingerprints::FingerprintsStringUtil::GenerateFingerprintsString</span><span class="s">(</span><span class="i">$This</span>->{<span class="w">FingerprintsObject</span>}<span class="cm">,</span> <span class="i">$This</span>->{<span class="w">BitStringFormat</span>}<span class="cm">,</span> <span class="i">$This</span>->{<span class="w">BitsOrder</span>}<span class="s">)</span><span class="sc">;</span> | |
1463 1450 <span class="s">}</span> | |
1464 1451 <span class="k">elsif</span> <span class="s">(</span><span class="i">$This</span>->{<span class="w">FingerprintsVectorStringMode</span>}<span class="s">)</span> <span class="s">{</span> | |
1465 1452 <span class="i">$This</span>->{<span class="w">FingerprintsString</span>} = <span class="i">Fingerprints::FingerprintsStringUtil::GenerateFingerprintsString</span><span class="s">(</span><span class="i">$This</span>->{<span class="w">FingerprintsObject</span>}<span class="cm">,</span> <span class="i">$This</span>->{<span class="w">VectorStringFormat</span>}<span class="s">)</span><span class="sc">;</span> | |
1466 1453 <span class="s">}</span> | |
1467 1454 | |
1468 1455 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
1469 1456 <span class="s">}</span> | |
1470 1457 | |
1471 1458 <span class="c"># Generate fingerprints string using partial fingerprints string and header keys data...</span> | |
1472 1459 <span class="c">#</span> | |
1473 1460 <span class="c"># Notes:</span> | |
1474 1461 <span class="c"># o FP file fingerprints data line only contain partial fingerprints data which</span> | |
1475 1462 <span class="c"># can't be used directly to create fingerprints bit-vector or vector objects</span> | |
1476 1463 <span class="c"># using functions available in FingerprintsStringUtil.pm module</span> | |
1477 1464 <span class="c">#</span> | |
1478 <a name="_GenerateFingerprintsStringFromPartialFingerprintsString-"></a>1465 <span class="k">sub </span><span class="m">_GenerateFingerprintsStringFromPartialFingerprintsString</span> <span class="s">{</span> | |
1479 1466 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
1480 1467 <span class="k">my</span><span class="s">(</span><span class="i">$FPStringDelim</span><span class="s">)</span><span class="sc">;</span> | |
1481 1468 | |
1482 1469 <span class="i">$This</span>->{<span class="w">FingerprintsString</span>} = <span class="q">''</span><span class="sc">;</span> | |
1483 1470 | |
1484 1471 <span class="k">if</span> <span class="s">(</span>!<span class="i">$This</span>->{<span class="w">PartialFingerprintsString</span>}<span class="s">)</span> <span class="s">{</span> | |
1485 1472 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
1486 1473 <span class="s">}</span> | |
1487 1474 | |
1488 1475 <span class="i">$FPStringDelim</span> = <span class="i">Fingerprints::FingerprintsStringUtil::GetFingeprintsStringDelimiter</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
1489 1476 | |
1490 1477 <span class="k">if</span> <span class="s">(</span><span class="i">$This</span>->{<span class="w">FingerprintsBitVectorStringMode</span>}<span class="s">)</span> <span class="s">{</span> | |
1491 1478 <span class="i">$This</span>->{<span class="w">FingerprintsString</span>} = <span class="i">$This</span>->{<span class="w">FingerprintsBitVectorStringPrefix</span>} . <span class="i">$FPStringDelim</span> . <span class="i">$This</span>->{<span class="w">PartialFingerprintsString</span>}<span class="sc">;</span> | |
1492 1479 <span class="s">}</span> | |
1493 1480 <span class="k">elsif</span> <span class="s">(</span><span class="i">$This</span>->{<span class="w">FingerprintsVectorStringMode</span>}<span class="s">)</span> <span class="s">{</span> | |
1494 1481 <span class="k">my</span><span class="s">(</span><span class="i">$NumOfValues</span><span class="cm">,</span> <span class="i">$VectorStringData</span><span class="s">)</span><span class="sc">;</span> | |
1495 1482 | |
1496 1483 <span class="s">(</span><span class="i">$NumOfValues</span><span class="cm">,</span> <span class="i">$VectorStringData</span><span class="s">)</span> = <span class="i">$This</span>->{<span class="w">PartialFingerprintsString</span>} =~ <span class="q">/^(.*?)$FPStringDelim(.*?)$/</span><span class="sc">;</span> | |
1497 1484 <span class="k">if</span> <span class="s">(</span>!<span class="s">(</span><span class="k">defined</span><span class="s">(</span><span class="i">$NumOfValues</span><span class="s">)</span> && <span class="k">defined</span><span class="s">(</span><span class="i">$VectorStringData</span><span class="s">)</span> && <span class="i">$VectorStringData</span><span class="s">)</span><span class="s">)</span> <span class="s">{</span> | |
1498 1485 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
1499 1486 <span class="s">}</span> | |
1500 1487 | |
1501 1488 <span class="i">$This</span>->{<span class="w">FingerprintsString</span>} = <span class="i">$This</span>->{<span class="w">FingerprintsVectorStringPrefix1</span>} . <span class="i">$FPStringDelim</span> . <span class="i">$NumOfValues</span> . <span class="i">$FPStringDelim</span> . <span class="i">$This</span>->{<span class="w">FingerprintsVectorStringPrefix2</span>} . <span class="i">$FPStringDelim</span> . <span class="i">$VectorStringData</span><span class="sc">;</span> | |
1502 1489 <span class="s">}</span> | |
1503 1490 | |
1504 1491 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
1505 1492 <span class="s">}</span> | |
1506 1493 | |
1507 1494 <span class="c"># Generate partial fingerprints string using fingerprints string and header keys data...</span> | |
1508 1495 <span class="c">#</span> | |
1509 1496 <span class="c"># Notes:</span> | |
1510 1497 <span class="c"># o FP file fingerprints data line only contain partial fingerprints data which</span> | |
1511 1498 <span class="c"># can't be used directly to create fingerprints bit-vector or vector objects</span> | |
1512 1499 <span class="c"># using functions available in FingerprintsStringUtil.pm module</span> | |
1513 1500 <span class="c">#</span> | |
1514 <a name="_GeneratePartialFingerprintsStringFromFingerprintsString-"></a>1501 <span class="k">sub </span><span class="m">_GeneratePartialFingerprintsStringFromFingerprintsString</span> <span class="s">{</span> | |
1515 1502 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
1516 1503 | |
1517 1504 <span class="i">$This</span>->{<span class="w">PartialFingerprintsString</span>} = <span class="q">''</span><span class="sc">;</span> | |
1518 1505 | |
1519 1506 <span class="k">if</span> <span class="s">(</span>!<span class="i">$This</span>->{<span class="w">FingerprintsString</span>}<span class="s">)</span> <span class="s">{</span> | |
1520 1507 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
1521 1508 <span class="s">}</span> | |
1522 1509 | |
1523 1510 <span class="k">if</span> <span class="s">(</span><span class="i">$This</span>->{<span class="w">FingerprintsBitVectorStringMode</span>}<span class="s">)</span> <span class="s">{</span> | |
1524 1511 <span class="k">my</span><span class="s">(</span><span class="i">$VectorType</span><span class="cm">,</span> <span class="i">$Description</span><span class="cm">,</span> <span class="i">$Size</span><span class="cm">,</span> <span class="i">$BitStringFormat</span><span class="cm">,</span> <span class="i">$BitsOrder</span><span class="cm">,</span> <span class="i">$BitVectorString</span><span class="s">)</span><span class="sc">;</span> | |
1525 1512 | |
1526 1513 <span class="s">(</span><span class="i">$VectorType</span><span class="cm">,</span> <span class="i">$Description</span><span class="cm">,</span> <span class="i">$Size</span><span class="cm">,</span> <span class="i">$BitStringFormat</span><span class="cm">,</span> <span class="i">$BitsOrder</span><span class="cm">,</span> <span class="i">$BitVectorString</span><span class="s">)</span> = <span class="i">Fingerprints::FingerprintsStringUtil::GetFingerprintsStringValues</span><span class="s">(</span><span class="i">$This</span>->{<span class="w">FingerprintsString</span>}<span class="s">)</span><span class="sc">;</span> | |
1527 1514 <span class="i">$This</span>->{<span class="w">PartialFingerprintsString</span>} = <span class="i">$BitVectorString</span><span class="sc">;</span> | |
1528 1515 <span class="s">}</span> | |
1529 1516 <span class="k">elsif</span> <span class="s">(</span><span class="i">$This</span>->{<span class="w">FingerprintsVectorStringMode</span>}<span class="s">)</span> <span class="s">{</span> | |
1530 1517 <span class="k">my</span><span class="s">(</span><span class="i">$FPStringDelim</span><span class="cm">,</span> <span class="i">$VectorType</span><span class="cm">,</span> <span class="i">$Description</span><span class="cm">,</span> <span class="i">$NumOfValues</span><span class="cm">,</span> <span class="i">$VectorValuesType</span><span class="cm">,</span> <span class="i">$VectorStringFormat</span><span class="cm">,</span> <span class="i">$VectorString1</span><span class="cm">,</span> <span class="i">$VectorString2</span><span class="cm">,</span> <span class="i">$VectorString</span><span class="s">)</span><span class="sc">;</span> | |
1531 1518 | |
1532 1519 <span class="i">$FPStringDelim</span> = <span class="i">Fingerprints::FingerprintsStringUtil::GetFingeprintsStringDelimiter</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span> | |
1533 1520 | |
1534 1521 <span class="s">(</span><span class="i">$VectorType</span><span class="cm">,</span> <span class="i">$Description</span><span class="cm">,</span> <span class="i">$NumOfValues</span><span class="cm">,</span> <span class="i">$VectorValuesType</span><span class="cm">,</span> <span class="i">$VectorStringFormat</span><span class="cm">,</span> <span class="i">$VectorString1</span><span class="cm">,</span> <span class="i">$VectorString2</span><span class="s">)</span> = <span class="i">Fingerprints::FingerprintsStringUtil::GetFingerprintsStringValues</span><span class="s">(</span><span class="i">$This</span>->{<span class="w">FingerprintsString</span>}<span class="s">)</span><span class="sc">;</span> | |
1535 1522 <span class="i">$VectorString</span> = <span class="i">TextUtil::IsEmpty</span><span class="s">(</span><span class="i">$VectorString2</span><span class="s">)</span> ? <span class="i">$VectorString1</span> <span class="co">:</span> <span class="q">"${VectorString1}${FPStringDelim}${VectorString2}"</span><span class="sc">;</span> | |
1536 1523 | |
1537 1524 <span class="i">$This</span>->{<span class="w">PartialFingerprintsString</span>} = <span class="i">$NumOfValues</span> . <span class="i">$FPStringDelim</span> . <span class="i">$VectorString</span><span class="sc">;</span> | |
1538 1525 <span class="s">}</span> | |
1539 1526 | |
1540 1527 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span> | |
1541 1528 <span class="s">}</span> | |
1542 1529 | |
1543 1530 <span class="c"># Is it a fingerprints file?</span> | |
1544 <a name="IsFingerprintsFPFile-"></a>1531 <span class="k">sub </span><span class="m">IsFingerprintsFPFile ($;$)</span> <span class="s">{</span> | |
1545 1532 <span class="k">my</span><span class="s">(</span><span class="i">$FirstParameter</span><span class="cm">,</span> <span class="i">$SecondParameter</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
1546 1533 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">$FileName</span><span class="cm">,</span> <span class="i">$Status</span><span class="s">)</span><span class="sc">;</span> | |
1547 1534 | |
1548 1535 <span class="k">if</span> <span class="s">(</span><span class="s">(</span><span class="i">@_</span> == <span class="n">2</span><span class="s">)</span> && <span class="s">(</span><span class="i">_IsFingerprintsFPFileIO</span><span class="s">(</span><span class="i">$FirstParameter</span><span class="s">)</span><span class="s">)</span><span class="s">)</span> <span class="s">{</span> | |
1549 1536 <span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">$FileName</span><span class="s">)</span> = <span class="s">(</span><span class="i">$FirstParameter</span><span class="cm">,</span> <span class="i">$SecondParameter</span><span class="s">)</span><span class="sc">;</span> | |
1550 1537 <span class="s">}</span> | |
1551 1538 <span class="k">else</span> <span class="s">{</span> | |
1552 1539 <span class="i">$FileName</span> = <span class="i">$FirstParameter</span><span class="sc">;</span> | |
1553 1540 <span class="s">}</span> | |
1554 1541 | |
1555 1542 <span class="c"># Check file extension...</span> | |
1556 1543 <span class="i">$Status</span> = <span class="i">FileUtil::CheckFileType</span><span class="s">(</span><span class="i">$FileName</span><span class="cm">,</span> <span class="q">"fpf fp"</span><span class="s">)</span><span class="sc">;</span> | |
1557 1544 | |
1558 1545 <span class="k">return</span> <span class="i">$Status</span><span class="sc">;</span> | |
1559 1546 <span class="s">}</span> | |
1560 1547 | |
1561 1548 <span class="c"># Is it a FingerprintsFPFileIO object?</span> | |
1562 <a name="_IsFingerprintsFPFileIO-"></a>1549 <span class="k">sub </span><span class="m">_IsFingerprintsFPFileIO</span> <span class="s">{</span> | |
1563 1550 <span class="k">my</span><span class="s">(</span><span class="i">$Object</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span> | |
1564 1551 | |
1565 1552 <span class="k">return</span> <span class="s">(</span><span class="i">Scalar::Util::blessed</span><span class="s">(</span><span class="i">$Object</span><span class="s">)</span> && <span class="i">$Object</span><span class="i">->isa</span><span class="s">(</span><span class="i">$ClassName</span><span class="s">)</span><span class="s">)</span> ? <span class="n">1</span> <span class="co">:</span> <span class="n">0</span><span class="sc">;</span> | |
1566 1553 <span class="s">}</span> | |
1567 1554 | |
1568 <a name="EOF-"></a></pre> | |
1569 <p> </p> | |
1570 <br /> | |
1571 <center> | |
1572 <img src="../../../images/h2o2.png"> | |
1573 </center> | |
1574 </body> | |
1575 </html> |