File: ensprotein.c

package info (click to toggle)
emboss 6.6.0%2Bdfsg-7
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 571,544 kB
  • sloc: ansic: 460,579; java: 29,439; perl: 13,573; sh: 12,754; makefile: 3,283; csh: 706; asm: 351; xml: 239; pascal: 237; modula3: 8
file content (1304 lines) | stat: -rw-r--r-- 37,163 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
/* @source ensprotein *********************************************************
**
** Ensembl Protein Feature functions
**
** @author Copyright (C) 1999 Ensembl Developers
** @author Copyright (C) 2006 Michael K. Schuster
** @version $Revision: 1.22 $
** @modified 2009 by Alan Bleasby for incorporation into EMBOSS core
** @modified $Date: 2013/02/17 13:02:11 $ by $Author: mks $
** @@
**
** This library is free software; you can redistribute it and/or
** modify it under the terms of the GNU Lesser General Public
** License as published by the Free Software Foundation; either
** version 2.1 of the License, or (at your option) any later version.
**
** This library is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
** Lesser General Public License for more details.
**
** You should have received a copy of the GNU Lesser General Public
** License along with this library; if not, write to the Free Software
** Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
** MA  02110-1301,  USA.
**
******************************************************************************/

/* ========================================================================= */
/* ============================= include files ============================= */
/* ========================================================================= */

#include "ensprotein.h"




/* ========================================================================= */
/* =============================== constants =============================== */
/* ========================================================================= */




/* ========================================================================= */
/* =========================== global variables ============================ */
/* ========================================================================= */




/* ========================================================================= */
/* ============================= private data ============================== */
/* ========================================================================= */




/* ========================================================================= */
/* =========================== private constants =========================== */
/* ========================================================================= */

/* @conststatic proteinfeatureadaptorKTablenames ******************************
**
** Array of Ensembl Protein Feature Adaptor SQL table names
**
******************************************************************************/

static const char *const proteinfeatureadaptorKTablenames[] =
{
    "protein_feature",
    (const char *) NULL
};




/* @conststatic proteinfeatureadaptorKColumnnames *****************************
**
** Array of Ensembl Protein Feature Adaptor SQL column names
**
******************************************************************************/

static const char *const proteinfeatureadaptorKColumnnames[] =
{
    "protein_feature.protein_feature_id",
    "protein_feature.translation_id",
    "protein_feature.seq_start",
    "protein_feature.seq_end",
    "protein_feature.hit_name",
    "protein_feature.hit_start",
    "protein_feature.hit_end",
    "protein_feature.analysis_id",
    "protein_feature.score",
    "protein_feature.evalue",
    "protein_feature.perc_ident",
    "interpro.interpro_ac",
    "xref.display_label",
    (const char *) NULL
};




/* @conststatic proteinfeatureadaptorKLeftjoins *******************************
**
** Array of Ensembl Protein Feature Adaptor SQL LEFT JOIN conditions
**
******************************************************************************/

static const EnsOBaseadaptorLeftjoin proteinfeatureadaptorKLeftjoins[] =
{
    {"interpro", "protein_feature.hit_name = interpro.id"},
    {"xref", "interpro.interpro_ac = xref.dbprimary_acc"},
    {(const char *) NULL, (const char *) NULL}
};




/* ========================================================================= */
/* =========================== private variables =========================== */
/* ========================================================================= */




/* ========================================================================= */
/* =========================== private functions =========================== */
/* ========================================================================= */

static AjBool proteinfeatureadaptorFetchAllbyStatement(
    EnsPBaseadaptor ba,
    const AjPStr statement,
    EnsPAssemblymapper am,
    EnsPSlice slice,
    AjPList pfs);




/* ========================================================================= */
/* ======================= All functions by section ======================== */
/* ========================================================================= */




/* @filesection ensprotein ****************************************************
**
** @nam1rule ens Function belongs to the Ensembl library
**
******************************************************************************/




/* @datasection [EnsPProteinfeature] Ensembl Protein Feature ******************
**
** @nam2rule Proteinfeature Functions for manipulating
** Ensembl Protein Feature objects
**
** @cc Bio::EnsEMBL::ProteinFeature
** @cc CVS Revision: 1.18
** @cc CVS Tag: branch-ensembl-68
**
******************************************************************************/





/* @section constructors ******************************************************
**
** All constructors return a new Ensembl Protein Feature by pointer.
** It is the responsibility of the user to first destroy any previous
** Protein Feature. The target pointer does not need to be initialised to
** NULL, but it is good programming practice to do so anyway.
**
** @fdata [EnsPProteinfeature]
**
** @nam3rule New Constructor
** @nam4rule Cpy Constructor with existing object
** @nam4rule Ini Constructor with initial values
** @nam4rule Ref Constructor by incrementing the reference counter
**
** @argrule Cpy pf [const EnsPProteinfeature] Ensembl Protein Feature
** @argrule Ini pfa [EnsPProteinfeatureadaptor] Ensembl Protein Feature Adaptor
** @argrule Ini identifier [ajuint] SQL database-internal identifier
** @argrule Ini fp [EnsPFeaturepair] Ensembl Feature Pair
** @argrule Ini accession [AjPStr] (InterPro) Accession
** @argrule Ini description [AjPStr] (InterPro) Description
** @argrule Ref pf [EnsPProteinfeature] Ensembl Protein Feature
**
** @valrule * [EnsPProteinfeature] Ensembl Protein Feature or NULL
**
** @fcategory new
******************************************************************************/




/* @func ensProteinfeatureNewCpy **********************************************
**
** Object-based constructor function, which returns an independent object.
**
** @param [r] pf [const EnsPProteinfeature] Ensembl Protein Feature
**
** @return [EnsPProteinfeature] Ensembl Protein Feature or NULL
**
** @release 6.4.0
** @@
******************************************************************************/

EnsPProteinfeature ensProteinfeatureNewCpy(const EnsPProteinfeature pf)
{
    EnsPProteinfeature pthis = NULL;

    if (!pf)
        return NULL;

    AJNEW0(pthis);

    pthis->Use         = 1U;
    pthis->Adaptor     = pf->Adaptor;
    pthis->Featurepair = ensFeaturepairNewRef(pf->Featurepair);

    if (pf->Accession)
        pthis->Accession = ajStrNewRef(pf->Accession);

    if (pf->Description)
        pthis->Description = ajStrNewRef(pf->Description);

    return pthis;
}




/* @func ensProteinfeatureNewIni **********************************************
**
** Constructor of an Ensembl Protein Feature with initial values.
**
** @cc Bio::EnsEMBL::Storable
** @param [u] pfa [EnsPProteinfeatureadaptor] Ensembl Protein Feature Adaptor
** @param [r] identifier [ajuint] SQL database-internal identifier
** @cc Bio::EnsEMBL::FeaturePair
** @param [u] fp [EnsPFeaturepair] Ensembl Feature Pair
** @cc Bio::EnsEMBL::ProteinFeature
** @param [u] accession [AjPStr] (InterPro) Accession
** @param [u] description [AjPStr] (InterPro) Description
**
** @return [EnsPProteinfeature] Ensembl Protein Feature or NULL
**
** @release 6.4.0
** @@
******************************************************************************/

EnsPProteinfeature ensProteinfeatureNewIni(EnsPProteinfeatureadaptor pfa,
                                           ajuint identifier,
                                           EnsPFeaturepair fp,
                                           AjPStr accession,
                                           AjPStr description)
{
    EnsPProteinfeature pf = NULL;

    AJNEW0(pf);

    pf->Use         = 1U;
    pf->Identifier  = identifier;
    pf->Adaptor     = pfa;
    pf->Featurepair = ensFeaturepairNewRef(fp);

    if (accession)
        pf->Accession = ajStrNewRef(accession);

    if (description)
        pf->Description = ajStrNewRef(description);

    return pf;
}




/* @func ensProteinfeatureNewRef **********************************************
**
** Ensembl Object referencing function, which returns a pointer to the
** Ensembl Object passed in and increases its reference count.
**
** @param [u] pf [EnsPProteinfeature] Ensembl Protein Feature
**
** @return [EnsPProteinfeature] Ensembl Protein Feature or NULL
**
** @release 6.2.0
** @@
******************************************************************************/

EnsPProteinfeature ensProteinfeatureNewRef(EnsPProteinfeature pf)
{
    if (!pf)
        return NULL;

    pf->Use++;

    return pf;
}




/* @section destructors *******************************************************
**
** Destruction destroys all internal data structures and frees the memory
** allocated for an Ensembl Protein Feature object.
**
** @fdata [EnsPProteinfeature]
**
** @nam3rule Del Destroy (free) an Ensembl Protein Feature
**
** @argrule * Ppf [EnsPProteinfeature*] Ensembl Protein Feature address
**
** @valrule * [void]
**
** @fcategory delete
******************************************************************************/




/* @func ensProteinfeatureDel *************************************************
**
** Default destructor for an Ensembl Protein Feature.
**
** @param [d] Ppf [EnsPProteinfeature*] Ensembl Protein Feature address
**
** @return [void]
**
** @release 6.2.0
** @@
******************************************************************************/

void ensProteinfeatureDel(EnsPProteinfeature *Ppf)
{
    EnsPProteinfeature pthis = NULL;

    if (!Ppf)
        return;

#if defined(AJ_DEBUG) && AJ_DEBUG >= 1
    if (ajDebugTest("ensProteinfeatureDel"))
    {
        ajDebug("ensProteinfeatureDel\n"
                "  *Ppf %p\n",
                *Ppf);

        ensProteinfeatureTrace(*Ppf, 1);
    }
#endif /* defined(AJ_DEBUG) && AJ_DEBUG >= 1 */

    if (!(pthis = *Ppf) || --pthis->Use)
    {
        *Ppf = NULL;

        return;
    }

    ensFeaturepairDel(&pthis->Featurepair);

    ajStrDel(&pthis->Accession);
    ajStrDel(&pthis->Description);

    ajMemFree((void **) Ppf);

    return;
}




/* @section member retrieval **************************************************
**
** Functions for returning members of an Ensembl Protein Feature object.
**
** @fdata [EnsPProteinfeature]
**
** @nam3rule Get Return Protein Feature attribute(s)
** @nam4rule Accession Return the accession
** @nam4rule Adaptor Return the Ensembl Protein Feature Adaptor
** @nam4rule Description Return the description
** @nam4rule Featurepair Return the Ensembl Feature Pair
** @nam4rule Identifier Return the SQL database-internal identifier
**
** @argrule * pf [const EnsPProteinfeature] Protein Feature
**
** @valrule Accession [AjPStr] Accession or NULL
** @valrule Adaptor [EnsPProteinfeatureadaptor] Ensembl Protein Feature Adaptor
** or NULL
** @valrule Description [AjPStr] Description or NULL
** @valrule Featurepair [EnsPFeaturepair] Ensembl Feature Pair or NULL
** @valrule Identifier [ajuint] SQL database-internal identifier or 0U
**
** @fcategory use
******************************************************************************/




/* @func ensProteinfeatureGetAccession ****************************************
**
** Get the (InterPro) accession member of an Ensembl Protein Feature.
**
** @param [r] pf [const EnsPProteinfeature] Ensembl Protein Feature
**
** @return [AjPStr] (InterPro) accession or NULL
**
** @release 6.2.0
** @@
******************************************************************************/

AjPStr ensProteinfeatureGetAccession(
    const EnsPProteinfeature pf)
{
    return (pf) ? pf->Accession : NULL;
}




/* @func ensProteinfeatureGetAdaptor ******************************************
**
** Get the Ensembl Protein Feature Adaptor member of an
** Ensembl Protein Feature.
**
** @param [r] pf [const EnsPProteinfeature] Ensembl Protein Feature
**
** @return [EnsPProteinfeatureadaptor] Ensembl Protein Feature Adaptor or NULL
**
** @release 6.2.0
** @@
******************************************************************************/

EnsPProteinfeatureadaptor ensProteinfeatureGetAdaptor(
    const EnsPProteinfeature pf)
{
    return (pf) ? pf->Adaptor : NULL;
}




/* @func ensProteinfeatureGetDescription **************************************
**
** Get the (InterPro) description member of an Ensembl Protein Feature.
**
** @param [r] pf [const EnsPProteinfeature] Ensembl Protein Feature
**
** @return [AjPStr] (InterPro) description or NULL
**
** @release 6.2.0
** @@
******************************************************************************/

AjPStr ensProteinfeatureGetDescription(
    const EnsPProteinfeature pf)
{
    return (pf) ? pf->Description : NULL;
}




/* @func ensProteinfeatureGetFeaturepair **************************************
**
** Get the Ensembl Feature Pair member of an Ensembl Protein Feature.
**
** @param [r] pf [const EnsPProteinfeature] Ensembl Protein Feature
**
** @return [EnsPFeaturepair] Ensembl Feature Pair or NULL
**
** @release 6.2.0
** @@
******************************************************************************/

EnsPFeaturepair ensProteinfeatureGetFeaturepair(
    const EnsPProteinfeature pf)
{
    return (pf) ? pf->Featurepair : NULL;
}




/* @func ensProteinfeatureGetIdentifier ***************************************
**
** Get the SQL database-internal identifier member of an
** Ensembl Protein Feature.
**
** @param [r] pf [const EnsPProteinfeature] Ensembl Protein Feature
**
** @return [ajuint] SQL database-internal identifier or 0U
**
** @release 6.2.0
** @@
******************************************************************************/

ajuint ensProteinfeatureGetIdentifier(
    const EnsPProteinfeature pf)
{
    return (pf) ? pf->Identifier : 0U;
}




/* @section member assignment *************************************************
**
** Functions for assigning members of an Ensembl Protein Feature object.
**
** @fdata [EnsPProteinfeature]
**
** @nam3rule Set Set one member of a Protein Feature
** @nam4rule Accession Set the accession
** @nam4rule Adaptor Set the Ensembl Protein Feature Adaptor
** @nam4rule Description Set the description
** @nam4rule Featurepair Set the Ensembl Feature Pair
** @nam4rule Identifier Set the SQL database-internal identifier
**
** @argrule * pf [EnsPProteinfeature] Ensembl Protein Feature object
** @argrule Accession accession [AjPStr] Accession
** @argrule Adaptor pfa [EnsPProteinfeatureadaptor] Ensembl Protein
**                                                  Feature Adaptor
** @argrule Description description [AjPStr] Description
** @argrule Featurepair fp [EnsPFeaturepair] Ensembl Feature Pair
** @argrule Identifier identifier [ajuint] SQL database-internal identifier
**
** @valrule * [AjBool] ajTrue upon success, ajFalse otherwise
**
** @fcategory modify
******************************************************************************/




/* @func ensProteinfeatureSetAccession ****************************************
**
** Set the accession member of an Ensembl Protein Feature.
**
** @param [u] pf [EnsPProteinfeature] Ensembl Protein Feature
** @param [u] accession [AjPStr] Accession
**
** @return [AjBool] ajTrue upon success, ajFalse otherwise
**
** @release 6.2.0
** @@
******************************************************************************/

AjBool ensProteinfeatureSetAccession(EnsPProteinfeature pf,
                                     AjPStr accession)
{
    if (!pf)
        return ajFalse;

    ajStrDel(&pf->Accession);

    pf->Accession = ajStrNewRef(accession);

    return ajTrue;
}




/* @func ensProteinfeatureSetAdaptor ******************************************
**
** Set the Ensembl Protein Feature Adaptor member of an
** Ensembl Protein Feature.
**
** @param [u] pf [EnsPProteinfeature] Ensembl Protein Feature
** @param [u] pfa [EnsPProteinfeatureadaptor] Ensembl Protein Feature Adaptor
**
** @return [AjBool] ajTrue upon success, ajFalse otherwise
**
** @release 6.2.0
** @@
******************************************************************************/

AjBool ensProteinfeatureSetAdaptor(EnsPProteinfeature pf,
                                   EnsPProteinfeatureadaptor pfa)
{
    if (!pf)
        return ajFalse;

    pf->Adaptor = pfa;

    return ajTrue;
}




/* @func ensProteinfeatureSetDescription **************************************
**
** Set the description member of an Ensembl Protein Feature.
**
** @param [u] pf [EnsPProteinfeature] Ensembl Protein Feature
** @param [u] description [AjPStr] Description
**
** @return [AjBool] ajTrue upon success, ajFalse otherwise
**
** @release 6.2.0
** @@
******************************************************************************/

AjBool ensProteinfeatureSetDescription(EnsPProteinfeature pf,
                                       AjPStr description)
{
    if (!pf)
        return ajFalse;

    ajStrDel(&pf->Description);

    pf->Description = ajStrNewRef(description);

    return ajTrue;
}




/* @func ensProteinfeatureSetFeaturepair **************************************
**
** Set the Ensembl Feature Pair member of an Ensembl Protein Feature.
**
** @param [u] pf [EnsPProteinfeature] Ensembl Protein Feature
** @param [u] fp [EnsPFeaturepair] Ensembl Feature Pair
**
** @return [AjBool] ajTrue upon success, ajFalse otherwise
**
** @release 6.2.0
** @@
******************************************************************************/

AjBool ensProteinfeatureSetFeaturepair(EnsPProteinfeature pf,
                                       EnsPFeaturepair fp)
{
    if (!pf)
        return ajFalse;

    ensFeaturepairDel(&pf->Featurepair);

    pf->Featurepair = ensFeaturepairNewRef(fp);

    return ajTrue;
}




/* @func ensProteinfeatureSetIdentifier ***************************************
**
** Set the SQL database-internal identifier member of an
** Ensembl Protein Feature.
**
** @param [u] pf [EnsPProteinfeature] Ensembl Protein Feature
** @param [r] identifier [ajuint] SQL database-internal identifier
**
** @return [AjBool] ajTrue upon success, ajFalse otherwise
**
** @release 6.2.0
** @@
******************************************************************************/

AjBool ensProteinfeatureSetIdentifier(EnsPProteinfeature pf,
                                      ajuint identifier)
{
    if (!pf)
        return ajFalse;

    pf->Identifier = identifier;

    return ajTrue;
}




/* @section debugging *********************************************************
**
** Functions for reporting of an Ensembl Protein Feature object.
**
** @fdata [EnsPProteinfeature]
**
** @nam3rule Trace Report Ensembl Protein Feature members to debug file
**
** @argrule Trace pf [const EnsPProteinfeature] Ensembl Protein Feature
** @argrule Trace level [ajuint] Indentation level
**
** @valrule * [AjBool] ajTrue upon success, ajFalse otherwise
**
** @fcategory misc
******************************************************************************/




/* @func ensProteinfeatureTrace ***********************************************
**
** Trace an Ensembl Protein Feature.
**
** @param [r] pf [const EnsPProteinfeature] Ensembl Protein Feature
** @param [r] level [ajuint] Indentation level
**
** @return [AjBool] ajTrue upon success, ajFalse otherwise
**
** @release 6.2.0
** @@
******************************************************************************/

AjBool ensProteinfeatureTrace(const EnsPProteinfeature pf, ajuint level)
{
    AjPStr indent = NULL;

    if (!pf)
        return ajFalse;

    indent = ajStrNew();

    ajStrAppendCountK(&indent, ' ', level * 2);

    ajDebug("%SensProteinfeatureTrace %p\n"
            "%S  Use %u\n"
            "%S  Identifier %u\n"
            "%S  Adaptor %p\n"
            "%S  Featurepair %p\n"
            "%S  Accession '%S'\n"
            "%S  Description '%S'\n",
            indent, pf,
            indent, pf->Use,
            indent, pf->Identifier,
            indent, pf->Adaptor,
            indent, pf->Featurepair,
            indent, pf->Accession,
            indent, pf->Description);

    ensFeaturepairTrace(pf->Featurepair, level + 1);

    ajStrDel(&indent);

    return ajTrue;
}




/* @section calculate *********************************************************
**
** Functions for calculating information from an
** Ensembl Protein Feature object.
**
** @fdata [EnsPProteinfeature]
**
** @nam3rule Calculate Calculate Ensembl Protein Feature information
** @nam4rule Memsize Calculate the memory size in bytes
**
** @argrule * pf [const EnsPProteinfeature] Ensembl Protein Feature
**
** @valrule Memsize [size_t] Memory size in bytes or 0
**
** @fcategory misc
******************************************************************************/




/* @func ensProteinfeatureCalculateMemsize ************************************
**
** Get the memory size in bytes of an Ensembl Protein Feature.
**
** @param [r] pf [const EnsPProteinfeature] Ensembl Protein Feature
**
** @return [size_t] Memory size in bytes or 0
**
** @release 6.4.0
** @@
******************************************************************************/

size_t ensProteinfeatureCalculateMemsize(const EnsPProteinfeature pf)
{
    size_t size = 0;

    if (!pf)
        return 0;

    size += sizeof (EnsOProteinfeature);

    size += ensFeaturepairCalculateMemsize(pf->Featurepair);

    if (pf->Accession)
    {
        size += sizeof (AjOStr);

        size += ajStrGetRes(pf->Accession);
    }

    if (pf->Description)
    {
        size += sizeof (AjOStr);

        size += ajStrGetRes(pf->Description);
    }

    return size;
}




/* @datasection [EnsPProteinfeatureadaptor] Ensembl Protein Feature Adaptor ***
**
** @nam2rule Proteinfeatureadaptor Functions for manipulating
** Ensembl Protein Feature Adaptor objects
**
** @cc Bio::EnsEMBL::DBSQL::ProteinFeatureAdaptor
** @cc CVS Revision: 1.35
** @cc CVS Tag: branch-ensembl-68
**
******************************************************************************/




/* @funcstatic proteinfeatureadaptorFetchAllbyStatement ***********************
**
** Run a SQL statement against an Ensembl Database Adaptor and consolidate the
** results into an AJAX List of Ensembl Protein Feature objects.
**
** @param [u] ba [EnsPBaseadaptor] Ensembl Base Adaptor
** @param [r] statement [const AjPStr] SQL statement
** @param [uN] am [EnsPAssemblymapper] Ensembl Assembly Mapper
** @param [uN] slice [EnsPSlice] Ensembl Slice
** @param [u] pfs [AjPList] AJAX List of Ensembl Protein Feature objects
**
** @return [AjBool] ajTrue upon success, ajFalse otherwise
**
** @release 6.4.0
** @@
******************************************************************************/

static AjBool proteinfeatureadaptorFetchAllbyStatement(
    EnsPBaseadaptor ba,
    const AjPStr statement,
    EnsPAssemblymapper am,
    EnsPSlice slice,
    AjPList pfs)
{
    double evalue  = 0.0;
    double score   = 0.0;

    float identity = 0.0F;

    ajuint identifier = 0U;
    ajuint tlstart    = 0U;
    ajuint tlend      = 0U;
    ajuint analysisid = 0U;
    ajuint hitstart   = 0U;
    ajuint hitend     = 0U;

    AjPSqlstatement sqls = NULL;
    AjISqlrow sqli       = NULL;
    AjPSqlrow sqlr       = NULL;

    AjPStr tlid        = NULL;
    AjPStr hitname     = NULL;
    AjPStr accession   = NULL;
    AjPStr description = NULL;

    EnsPAnalysis analysis  = NULL;
    EnsPAnalysisadaptor aa = NULL;

    EnsPDatabaseadaptor dba = NULL;

    EnsPFeature srcfeature = NULL;
    EnsPFeature trgfeature = NULL;

    EnsPFeaturepair fp = NULL;

    EnsPProteinfeature pf         = NULL;
    EnsPProteinfeatureadaptor pfa = NULL;

    if (ajDebugTest("proteinfeatureadaptorFetchAllbyStatement"))
        ajDebug("proteinfeatureadaptorFetchAllbyStatement\n"
                "  ba %p\n"
                "  statement %p\n"
                "  am %p\n"
                "  slice %p\n"
                "  pfs %p\n",
                ba,
                statement,
                am,
                slice,
                pfs);

    if (!ba)
        return ajFalse;

    if (!statement)
        return ajFalse;

    if (!pfs)
        return ajFalse;

    dba = ensBaseadaptorGetDatabaseadaptor(ba);

    aa  = ensRegistryGetAnalysisadaptor(dba);
    pfa = ensRegistryGetProteinfeatureadaptor(dba);

    sqls = ensDatabaseadaptorSqlstatementNew(dba, statement);

    sqli = ajSqlrowiterNew(sqls);

    while (!ajSqlrowiterDone(sqli))
    {
        identifier  = 0;
        tlid        = ajStrNew();
        tlstart     = 0;
        tlend       = 0;
        hitname     = ajStrNew();
        hitstart    = 0;
        hitend      = 0;
        analysisid  = 0;
        score       = 0.0;
        evalue      = 0.0;
        identity    = 0.0F;
        accession   = ajStrNew();
        description = ajStrNew();

        sqlr = ajSqlrowiterGet(sqli);

        ajSqlcolumnToUint(sqlr, &identifier);
        ajSqlcolumnToStr(sqlr, &tlid);
        ajSqlcolumnToUint(sqlr, &tlstart);
        ajSqlcolumnToUint(sqlr, &tlend);
        ajSqlcolumnToStr(sqlr, &hitname);
        ajSqlcolumnToUint(sqlr, &hitstart);
        ajSqlcolumnToUint(sqlr, &hitend);
        ajSqlcolumnToUint(sqlr, &analysisid);
        ajSqlcolumnToDouble(sqlr, &score);
        ajSqlcolumnToDouble(sqlr, &evalue);
        ajSqlcolumnToFloat(sqlr, &identity);
        ajSqlcolumnToStr(sqlr, &accession);
        ajSqlcolumnToStr(sqlr, &description);

        ensAnalysisadaptorFetchByIdentifier(aa, analysisid, &analysis);

        /*
        ** NOTE: The translation_id is currently handled as an AJAX String
        ** to fit into the seqname member of an Ensembl Feature.
        */

        srcfeature = ensFeatureNewIniN(analysis, tlid, tlstart, tlend, 1);

        trgfeature = ensFeatureNewIniN((EnsPAnalysis) NULL,
                                       hitname,
                                       hitstart,
                                       hitend,
                                       1);

        fp = ensFeaturepairNewIni(srcfeature,
                                  trgfeature,
                                  (EnsPExternaldatabase) NULL, /* edb */
                                  (AjPStr) NULL, /* extra data */
                                  (AjPStr) NULL, /* srcspecies */
                                  (AjPStr) NULL, /* trgspecies */
                                  0, /* groupid */
                                  0, /* levelid */
                                  evalue,
                                  score,
                                  0, /* srccoverage */
                                  0, /* trgcoverage */
                                  identity);

        /* Create a Protein Feature object. */

        pf = ensProteinfeatureNewIni(pfa,
                                     identifier,
                                     fp,
                                     accession,
                                     description);

        ajListPushAppend(pfs, (void *) pf);

        ensFeaturepairDel(&fp);

        ensFeatureDel(&srcfeature);
        ensFeatureDel(&trgfeature);

        ajStrDel(&tlid);
        ajStrDel(&hitname);
        ajStrDel(&accession);
        ajStrDel(&description);

        ensAnalysisDel(&analysis);
    }

    ajSqlrowiterDel(&sqli);

    ensDatabaseadaptorSqlstatementDel(dba, &sqls);

    return ajTrue;
}




/* @section constructors ******************************************************
**
** All constructors return a new Ensembl Protein Feature Adaptor by pointer.
** It is the responsibility of the user to first destroy any previous
** Protein Feature Adaptor. The target pointer does not need to be
** initialised to NULL, but it is good programming practice to do so anyway.
**
** @fdata [EnsPProteinfeatureadaptor]
**
** @nam3rule New Constructor
**
** @argrule New dba [EnsPDatabaseadaptor] Ensembl Database Adaptor
**
** @valrule * [EnsPProteinfeatureadaptor]
** Ensembl Protein Feature Adaptor or NULL
**
** @fcategory new
******************************************************************************/




/* @func ensProteinfeatureadaptorNew ******************************************
**
** Default constructor for an Ensembl Protein Feature Adaptor.
**
** Ensembl Object Adaptors are singleton objects in the sense that a single
** instance of an Ensembl Object Adaptor connected to a particular database is
** sufficient to instantiate any number of Ensembl Objects from the database.
** Each Ensembl Object will have a weak reference to the Object Adaptor that
** instantiated it. Therefore, Ensembl Object Adaptors should not be
** instantiated directly, but rather obtained from the Ensembl Registry,
** which will in turn call this function if neccessary.
**
** @see ensRegistryGetDatabaseadaptor
** @see ensRegistryGetProteinfeatureadaptor
**
** @param [u] dba [EnsPDatabaseadaptor] Ensembl Database Adaptor
**
** @return [EnsPProteinfeatureadaptor] Ensembl Protein Feature Adaptor or NULL
**
** @release 6.2.0
** @@
******************************************************************************/

EnsPProteinfeatureadaptor ensProteinfeatureadaptorNew(
    EnsPDatabaseadaptor dba)
{
    return ensBaseadaptorNew(
        dba,
        proteinfeatureadaptorKTablenames,
        proteinfeatureadaptorKColumnnames,
        proteinfeatureadaptorKLeftjoins,
        (const char *) NULL,
        (const char *) NULL,
        &proteinfeatureadaptorFetchAllbyStatement);
}




/* @section destructors *******************************************************
**
** Destruction destroys all internal data structures and frees the memory
** allocated for an Ensembl Protein Feature Adaptor object.
**
** @fdata [EnsPProteinfeatureadaptor]
**
** @nam3rule Del Destroy (free) an Ensembl Protein Feature Adaptor
**
** @argrule * Ppfa [EnsPProteinfeatureadaptor*]
** Ensembl Protein Feature Adaptor address
**
** @valrule * [void]
**
** @fcategory delete
******************************************************************************/




/* @func ensProteinfeatureadaptorDel ******************************************
**
** Default destructor for an Ensembl Protein Feature Adaptor.
**
** Ensembl Object Adaptors are singleton objects that are registered in the
** Ensembl Registry and weakly referenced by Ensembl Objects that have been
** instantiated by it. Therefore, Ensembl Object Adaptors should never be
** destroyed directly. Upon exit, the Ensembl Registry will call this function
** if required.
**
** @param [d] Ppfa [EnsPProteinfeatureadaptor*]
** Ensembl Protein Feature Adaptor address
**
** @return [void]
**
** @release 6.2.0
** @@
******************************************************************************/

void ensProteinfeatureadaptorDel(EnsPProteinfeatureadaptor *Ppfa)
{
    ensBaseadaptorDel(Ppfa);

    return;
}




/* @section member retrieval **************************************************
**
** Functions for returning members of an
** Ensembl Protein Feature Adaptor object.
**
** @fdata [EnsPProteinfeatureadaptor]
**
** @nam3rule Get Return Ensembl Protein Feature Adaptor attribute(s)
** @nam4rule Baseadaptor Return the Ensembl Base Adaptor
** @nam4rule Databaseadaptor Return the Ensembl Database Adaptor
**
** @argrule * pfa [EnsPProteinfeatureadaptor] Ensembl Protein Feature Adaptor
**
** @valrule Baseadaptor [EnsPBaseadaptor]
** Ensembl Base Adaptor or NULL
** @valrule Databaseadaptor [EnsPDatabaseadaptor]
** Ensembl Database Adaptor or NULL
**
** @fcategory use
******************************************************************************/




/* @func ensProteinfeatureadaptorGetBaseadaptor *******************************
**
** Get the Ensembl Base Adaptor member of an
** Ensembl Protein Feature Adaptor.
**
** @param [u] pfa [EnsPProteinfeatureadaptor] Ensembl Protein Feature Adaptor
**
** @return [EnsPBaseadaptor] Ensembl Base Adaptor or NULL
**
** @release 6.5.0
** @@
******************************************************************************/

EnsPBaseadaptor ensProteinfeatureadaptorGetBaseadaptor(
    EnsPProteinfeatureadaptor pfa)
{
    return pfa;
}




/* @func ensProteinfeatureadaptorGetDatabaseadaptor ***************************
**
** Get the Ensembl Database Adaptor member of an
** Ensembl Protein Feature Adaptor.
**
** @param [u] pfa [EnsPProteinfeatureadaptor] Ensembl Protein Feature Adaptor
**
** @return [EnsPDatabaseadaptor] Ensembl Database Adaptor or NULL
**
** @release 6.4.0
** @@
******************************************************************************/

EnsPDatabaseadaptor ensProteinfeatureadaptorGetDatabaseadaptor(
    EnsPProteinfeatureadaptor pfa)
{
    return ensBaseadaptorGetDatabaseadaptor(
        ensProteinfeatureadaptorGetBaseadaptor(pfa));
}




/* @section object retrieval **************************************************
**
** Functions for fetching Ensembl Protein Feature objects from an
** Ensembl SQL database.
**
** @fdata [EnsPProteinfeatureadaptor]
**
** @nam3rule Fetch Fetch Ensembl Protein Feature object(s)
** @nam4rule All   Fetch all Ensembl Protein Feature objects
** @nam4rule Allby Fetch all Ensembl Protein Feature objects
**                      matching a criterion
** @nam5rule Translationidentifier Fetch all by an Ensembl Translation
**                                 identifier
** @nam4rule By    Fetch one Ensembl Protein Feature object
**                 matching a criterion
** @nam5rule Identifier Fetch by a SQL database-internal identifier
**
** @argrule * pfa [EnsPProteinfeatureadaptor]
** Ensembl Protein Feature Adaptor
** @argrule AllbyTranslationidentifier tlid [ajuint]
** Ensembl Translation identifier
** @argrule AllbyTranslationidentifier pfs [AjPList]
** AJAX List of Ensembl Protein Feature objects
** @argrule ByIdentifier identifier [ajuint]
** SQL database-internal identifier
** @argrule ByIdentifier Ppf [EnsPProteinfeature*]
** Ensembl Protein Feature address
**
** @valrule * [AjBool] ajTrue upon success, ajFalse otherwise
**
** @fcategory use
******************************************************************************/




/* @func ensProteinfeatureadaptorFetchAllbyTranslationidentifier **************
**
** Fetch an Ensembl Protein Feature via an Ensembl Translation identifier.
** The caller is responsible for deleting the Ensembl Protein Feature.
**
** @param [u] pfa [EnsPProteinfeatureadaptor] Ensembl Protein Feature Adaptor
** @param [r] tlid [ajuint] Ensembl Translation identifier
** @param [u] pfs [AjPList] AJAX List of Ensembl Protein Feature objects
**
** @return [AjBool] ajTrue upon success, ajFalse otherwise
**
** @release 6.4.0
** @@
******************************************************************************/

AjBool ensProteinfeatureadaptorFetchAllbyTranslationidentifier(
    EnsPProteinfeatureadaptor pfa,
    ajuint tlid,
    AjPList pfs)
{
    AjBool result = AJFALSE;

    AjPStr constraint = NULL;

    if (!pfa)
        return ajFalse;

    if (!tlid)
        return ajFalse;

    if (!pfs)
        return ajFalse;

    constraint = ajFmtStr("protein_feature.translation_id = %u", tlid);

    result = ensBaseadaptorFetchAllbyConstraint(
        ensProteinfeatureadaptorGetBaseadaptor(pfa),
        constraint,
        (EnsPAssemblymapper) NULL,
        (EnsPSlice) NULL,
        pfs);

    ajStrDel(&constraint);

    return result;
}




/* @func ensProteinfeatureadaptorFetchByIdentifier ****************************
**
** Fetch an Ensembl Protein Feature by its SQL database-internal identifier.
**
** @param [u] pfa [EnsPProteinfeatureadaptor] Ensembl Protein Feature Adaptor
** @param [r] identifier [ajuint] SQL database-internal identifier
** @param [wP] Ppf [EnsPProteinfeature*] Ensembl Protein Feature address
**
** @return [AjBool] ajTrue upon success, ajFalse otherwise
**
** @release 6.2.0
** @@
******************************************************************************/

AjBool ensProteinfeatureadaptorFetchByIdentifier(
    EnsPProteinfeatureadaptor pfa,
    ajuint identifier,
    EnsPProteinfeature *Ppf)
{
    return ensBaseadaptorFetchByIdentifier(
        ensProteinfeatureadaptorGetBaseadaptor(pfa),
        identifier,
        (void **) Ppf);
}