1Biber::DataList(3) User Contributed Perl Documentation Biber::DataList(3)
2
6 Biber::DataList - Biber::DataLists objects
7 new
9 Initialize a Biber::DataList object
10 set_section
12 Sets the section of a data list
13 get_section
15 Gets the section of a data list
16 reset_state
18 Resets all state data. Used mainly in tests which call Biber::prepare()
19 multiple times without re-creating datalists
20 incr_seenpa
22 Increment the count of occurrences of a primary author base name
23 if it has a different non-base part. How many variants of the basename
24 are there in the dlist?
25 get_seenpa
27 Get the count of unique (i.e. with different hash) occurrences of a primary
28 author base name
29 reset_entryfields
31 Resets all entryfield data in a list
32 get_entryfield
34 Retrieves per-list datafield information for an entry
35 set_entryfield
37 Records per-list datafield information for an entry
38 add_uniquenamecount
40 Add a name to the list of name contexts which have the name in it
41 (only called for visible names)
42 add_uniquenamecount_all
44 Add a name to the list of name contexts which have the name in it
45 (called for all names)
46 get_uniquelistcount
48 Get the number of uniquelist entries for a (possibly partial) list
49 add_uniquelistcount
51 Increment the count for a list part to the data for a name
52 add_uniquelistcount_final
54 Increment the count for a complete list to the data for a name
55 add_uniquelistcount_minyear
57 Increment the count for a list and year for a name
58 Used to track uniquelist = minyear
59 get_uniquelistcount_minyear
61 Get the count for a list and year for a name
62 Used to track uniquelist = minyear
63 get_uniquelistcount_final
65 Get the number of uniquelist entries for a full list
66 reset_uniquelistcount
68 Reset the count for list parts and complete lists
69 reset_uniquenamecount
71 Reset the list of names which have the name part in it
72 get_basenamestring
74 Get a basenamestring for a particular name
75 get_namestring
77 Get a namestring for a particular name
78 get_namestrings
80 Get namestrings for a particular name
81 set_namedis
83 Set name disambiguation metadata
84 is_unbasepart
86 Return boolean to say if a namepart is a base part according to
87 template which created the information
88 get_namehash
90 Get hash for a name
91 set_namehash
93 Set hash for a name
94 get_unmininfo
96 Get uniquename minimalness info for a name
97 set_unmininfo
99 Set uniquename minimalness info for a name
100 get_namedisschema
102 Get a name disambiguation schema for a name
103 get_unsummary
105 Get legacy uniquename summary for a name
106 get_unpart
108 Get uniquename summary part for a name
109 get_unparts
111 Get uniquename parts for a name
112 set_unparts
114 Set uniquename parts for a name
115 _get_uniquename
117 Get the list of name contexts which contain a name
118 Mainly for use in tests
119 get_uniquename
121 Get uniquename for a name
122 set_uniquename
124 Set uniquename for a name
125 reset_uniquename
127 Reset uniquename for a name
128 get_uniquename_all
130 Get uniquename for a name, regardless of visibility
131 set_uniquename_all
133 Set uniquename for a name, regardless of visibility
134 count_uniquelist
136 Count the names in a string used to determine uniquelist.
137 get_uniquelist
139 Gets a uniquelist setting for a namelist
140 set_uniquelist
142 Sets a uniquelist setting for a namelist
143 get_visible_cite
145 Gets citation name list visibility
146 set_visible_cite
148 Gets citation name list visibility
149 get_visible_bib
151 Gets bib name list visibility
152 set_visible_bib
154 Gets bib name list visibility
155 get_visible_sort
157 Gets sort name list visibility
158 set_visible_sort
160 Gets sort name list visibility
161 get_visible_alpha
163 Gets alpha name list visibility
164 set_visible_alpha
166 Gets alpha name list visibility
167 get_numofuniquenames
169 Get the number of uniquenames entries for a visible name
170 get_numofuniquenames_all
172 Get the number of uniquenames entries for a name
173 get_unul_done
175 Return a boolean saying whether uniquenename+uniquelist processing is finished
176 set_unul_changed
178 Set a boolean saying whether uniquename+uniquelist has changed
179 reset_seen_extra
181 Reset the counters for extra*
182 incr_seen_extradate
184 Increment and return the counter for extradate
185 incr_seen_extraname
187 Increment and return the counter for extraname
188 incr_seen_labelname
190 Increment and return a counter used to track extraname
191 incr_seen_extratitle
193 Increment and return the counter for extratitle
194 incr_seen_extratitleyear
196 Increment and return the counter for extratitleyear
197 incr_seen_extraalpha
199 Increment and return the counter for extraalpha
200 get_seen_namedateparts
202 Get the count of an labelname/dateparts combination for tracking
203 extradate. It uses labelyear plus name as we need to disambiguate
204 entries with different labelyear (like differentiating 1984--1986 from
205 just 1984)
206 incr_seen_namedateparts
208 Increment the count of an labelname/dateparts combination for extradate
209 We pass in the name and date strings separately as we have to
211 be careful and only increment this counter beyond 1 if there is
212 a name component. Otherwise, extradate gets defined for all
213 entries with no name but the same year etc.
214 get_seen_labelname
216 Get the count of a labelname hash for tracking extraname
217 get_seen_nametitle
219 Get the count of an labelname/labeltitle combination for tracking
220 extratitle.
221 incr_seen_nametitle
223 Increment the count of an labelname/labeltitle combination for extratitle
224 We pass in the name and year strings separately as we have to
226 be careful and only increment this counter beyond 1 if there is
227 a title component. Otherwise, extratitle gets defined for all
228 entries with no title.
229 get_seen_titleyear
231 Get the count of an labeltitle/labelyear combination for tracking
232 extratitleyear
233 incr_seen_titleyear
235 Increment the count of an labeltitle/labelyear combination for extratitleyear
236 We pass in the title and year strings separately as we have to
238 be careful and only increment this counter beyond 1 if there is
239 a title component. Otherwise, extratitleyear gets defined for all
240 entries with no title.
241 reset_workuniqueness
243 Reset various work uniqueness counters
244 get_seenname
246 Get the count of occurrences of a labelname or labeltitle
247 incr_seenname
249 Increment the count of occurrences of a labelname or labeltitle
250 get_seentitle
252 Get the count of occurrences of a labeltitle
253 incr_seentitle
255 Increment the count of occurrences of a labeltitle
256 get_seenbaretitle
258 Get the count of occurrences of a labeltitle when there is
259 no labelname
260 incr_seenbaretitle
262 Increment the count of occurrences of a labeltitle
263 when there is no labelname
264 get_seenwork
266 Get the count of occurrences of a labelname and labeltitle
267 incr_seenwork
269 Increment the count of occurrences of a labelname and labeltitle
270 incr_la_disambiguation
272 Increment a counter to say we have seen this labelalpha
273 get_la_disambiguation
275 Get the disambiguation counter for this labelalpha.
276 Return a 0 for undefs to avoid spurious errors.
277 set_sortingtemplatename
279 Sets the sortingtemplate name of a data list
280 get_attrs
282 Gets the attributes of a data list
283 get_sortingtemplatename
285 Gets the sortingtemplatename of a data list
286 set_sortingnamekeytemplatename
288 Sets the sortingnamekeytemplate name of a data list
289 get_sortingnamekeytemplatename
291 Gets the sortingnamekeytemplatename of a data list
292 set_uniquenametemplatename
294 Sets the uniquenametemplate name of a data list
295 get_uniquenametemplatename
297 Gets the uniquenametemplate name of a data list
298 set_labelalphanametemplatename
300 Sets the labelalphanametemplate name of a data list
301 get_labelalphanametemplatename
303 Gets the labelalphanametemplate name of a data list
304 set_sortinit_collator
306 Sets the sortinit collator for this list
307 get_sortinit_collator
309 Gets the sortinit collator for this list
310 get_labelprefix
312 Gets the labelprefix setting of a data list
313 set_labelprefix
315 Sets the labelprefix setting of a data list
316 set_name
318 Sets the name of a data list
319 get_name
321 Gets the name of a data list
322 set_type
324 Sets the type of a data list
325 get_type
327 Gets the type of a section list
328 set_keys
330 Sets the keys for the list
331 get_keys
333 Gets the keys for the list
334 count_keys
336 Count the keys for the list
337 get_namelistdata
339 Gets name list data
340 set_namelistdata
342 Saves name list data
343 get_labelalphadata
345 Gets labelalpha field data
346 set_labelalphadata
348 Saves labelalpha data
349 get_labelalphadata_for_key
351 Gets labelalpha field data for a key
352 set_labelalphadata_for_key
354 Saves labelalpha field data for a key
355 set_extradatedata_for_key
357 Saves extradate field data for a key
358 set_extranamedata_for_key
360 Saves extraname field data for a key
361 get_extranamedata_for_key
363 Gets the extraname field data for a key
364 set_extradatedata
366 Saves extradate field data for all keys
367 get_extradatedata_for_key
369 Gets the extradate field data for a key
370 set_extratitledata_for_key
372 Saves extratitle field data for a key
373 set_extratitledata
375 Saves extratitle field data for all keys
376 get_extratitledata
378 Gets the extratitle field data for a key
379 set_extratitleyeardata_for_key
381 Saves extratitleyear field data for a key
382 set_extratitleyeardata
384 Saves extratitleyear field data for all keys
385 get_extratitleyeardata
387 Gets the extratitleyear field data for a key
388 set_extraalphadata_for_key
390 Saves extraalpha field data for a key
391 set_extraalphadata
393 Saves extraalpha field data for all keys
394 get_extraalphadata
396 Gets the extraalpha field data for a key
397 get_sortdataschema
399 Gets the sortdata schema for a sortlist
400 set_sortdataschema
402 Saves the sortdata schema for a sortlist
403 set_sortdata
405 Saves sorting data in a list for a key
406 get_sortdata_for_key
408 Gets the sorting data in a list for a key
409 set_sortinitdata_for_key
411 Saves sortinit data for a specific key
412 set_sortinitdata
414 Saves sortinit data for all keys
415 get_sortinit_for_key
417 Gets the sortinit in a list for a key
418 set_sortingtemplate
420 Sets the sortingtemplate of a list
421 get_sortingtemplate
423 Gets the sortingtemplate of a list
424 add_filter
426 Adds a filter to a list object
427 get_filters
429 Gets all filters for a list object
430 instantiate_entry
432 Do any dynamic information replacement for information
433 which varies in an entry between lists. This is information which
434 needs to be output to the .bbl for an entry but which is a property
435 of the reference context and not the entry per se so it cannot be stored
436 statically in the entry and must be retrieved from the specific datalist
437 when outputting the entry.
438 namelist_differs_index
440 Returns the index where the name list begins to differ from any other list
441 Assuming these lists
443 [a, b]
445 [a, b, d, e, f, g, h, i, j]
446 [a, b, d, e, f]
447 [a, b, e, z, z, y]
448 namelist_differs_index([a, b, c, d, e]) -> 2
450 namelist_differs_index([a]) -> 1
451 namelist_differs_nth
453 Returns true if some other name list differs at passed nth place
454 and is at least as long
455 namelist_differs_nth([a, b, c, d, e], 3) = 1
457 if there is another name list like any of these:
459 [a, b, d, e, f]
461 [a, b, e, z, z, y]
462
464 Philip Kime "<philip at kime.org.uk>"
465
467 Please report any bugs or feature requests on our Github tracker at
468 <https://github.com/plk/biber/issues>.
469
471 Copyright 2012-2022 Philip Kime, all rights reserved.
472 This module is free software. You can redistribute it and/or modify it
474 under the terms of the Artistic License 2.0.
475 This program is distributed in the hope that it will be useful, but
477 without any warranty; without even the implied warranty of
478 merchantability or fitness for a particular purpose.
479perl v5.34.0 2022-01-31 Biber::DataList(3)