1Biber::DataModel(3)   User Contributed Perl Documentation  Biber::DataModel(3)
2
3
4

NAME

6       Biber::DataModel - Biber::DataModel objects
7
8   new
9           Initialize a Biber::DataModel object
10           We are passing in an array of datamodels as there may be more than one in tool
11           mode - the one from biber-tool.conf and modifications in a user .conf
12           We first merge these before extracting data. In case of conflicts, user .conf
13           datamodel takes precedence.
14
15   get_outcase
16           Returns the original datamodel field/entrytype case for output
17
18   constants
19           Returns array ref of constant names
20
21   get_constant_type
22           Returns a constant type
23
24   get_constant_value
25           Returns a constant value
26
27   is_multiscript
28           Returns boolean to say if a field is a multiscript field
29
30   fieldtypes
31           Returns array ref of legal fieldtypes
32
33   datatypes
34           Returns array ref of legal datatypes
35
36   is_field
37           Returns boolean to say if a field is a legal field.
38           Allows for fields with meta markers whose marked field should be in
39           the datamodel.
40
41   entrytypes
42           Returns array ref of legal entrytypes
43
44   is_entrytype
45           Returns boolean to say if an entrytype is a legal entrytype
46
47   is_field_for_entrytype
48           Returns boolean to say if a field is legal for an entrytype
49
50   entrytype_is_skipout
51           Returns boolean depending on whether an entrytype is to be skipped on output
52
53   get_fields_of_fieldtype
54           Retrieve fields of a certain biblatex fieldtype from data model
55           Return in sorted order so that bbl order doesn't change when changing
56           .bcf. This really messes up tests otherwise.
57
58   get_fields_of_fieldformat
59           Retrieve fields of a certain format from data model
60           Return in sorted order so that bbl order doesn't change when changing
61           .bcf. This really messes up tests otherwise.
62
63   get_fields_of_datatype
64           Retrieve fields of a certain biblatex datatype from data model
65           Return in sorted order so that bbl order doesn't change when changing
66           .bcf. This really messes up tests otherwise.
67
68   get_fields_of_type
69           Retrieve fields of a certain biblatex type from data model
70           Return in sorted order so that bbl order doesn't change when changing
71           .bcf. This really messes up tests otherwise.
72
73   is_fields_of_type
74         Returns boolean to say if the given fieldtype/datatype/format is a valid combination
75
76   get_fieldtype
77           Returns the fieldtype of a field
78
79   get_datatype
80           Returns the datatype of a field
81
82   get_fieldformat
83           Returns the format of a field
84
85   get_dm_for_field
86           Returns the fieldtype, datatype and format of a field
87
88   field_is_fieldtype
89           Returns boolean depending on whether a field is a certain biblatex fieldtype
90
91   field_is_datatype
92           Returns boolean depending on whether a field is a certain biblatex datatype
93
94   field_is_type
95           Returns boolean depending on whether a field is a certain biblatex fieldtype
96           and datatype
97
98   field_is_nullok
99           Returns boolean depending on whether a field is ok to be null
100
101   field_is_skipout
102           Returns boolean depending on whether a field is to be skipped on output
103
104   check_mandatory_constraints
105           Checks constraints of type "mandatory" on entry and
106           returns an arry of warnings, if any
107
108   check_conditional_constraints
109           Checks constraints of type "conditional" on entry and
110           returns an arry of warnings, if any
111
112   check_data_constraints
113           Checks constraints of type "data" on entry and
114           returns an array of warnings, if any
115
116   check_datatypes
117           Checks datatypes of fields against fields. These are not explicit constraints
118           in the datamodel but rather checks of the datatype of fields in the datamodel.
119
120   dump
121           Dump Biber::DataModel object
122
123   generate_bltxml_schema
124           Generate a RelaxNG XML schema from the datamodel for BibLaTeXML datasources
125
126   generate_bblxml_schema
127           Generate a RelaxNG XML schema from the datamodel for bblXML output
128

AUTHORS

130       Philip Kime "<philip at kime.org.uk>"
131

BUGS

133       Please report any bugs or feature requests on our Github tracker at
134       <https://github.com/plk/biber/issues>.
135

137       Copyright 2012-2022 Philip Kime, all rights reserved.
138
139       This module is free software.  You can redistribute it and/or modify it
140       under the terms of the Artistic License 2.0.
141
142       This program is distributed in the hope that it will be useful, but
143       without any warranty; without even the implied warranty of
144       merchantability or fitness for a particular purpose.
145
146
147
148perl v5.34.0                      2022-01-31               Biber::DataModel(3)
Impressum