Biber::DataList(3)

NAME
Biber::DataList - Biber::DataList objects

  new
    Initialize a Biber::DataList object

  set_section
    Sets the section of a data list

  get_section
    Gets the section of a data list

  reset_state
    Resets all state data. Used mainly in tests which call Biber::prepare()
    multiple times without re-creating datalists

  incr_seenpa
    Increment the count of occurrences of a primary author base name
    if it has a different non-base part. How many variants of the basename
    are there in the dlist?

  get_seenpa
    Get the count of unique (i.e. with different hash) occurrences of a primary
    author base name

  reset_entryfields
    Resets all entryfield data in a list

  get_entryfield
    Retrieves per-list datafield information for an entry

  set_entryfield
    Records per-list datafield information for an entry

  add_uniquenamecount
    Add a name to the list of name contexts which have the name in it
    (only called for visible names)

  add_uniquenamecount_all
    Add a name to the list of name contexts which have the name in it
    (called for all names)

  get_uniquelistcount
    Get the number of uniquelist entries for a (possibly partial) list

  add_uniquelistcount
    Increment the count for a list part to the data for a name

  add_uniquelistcount_final
    Increment the count for a complete list to the data for a name

  add_uniquelistcount_minyear
    Increment the count for a list and year for a name
    Used to track uniquelist = minyear

  get_uniquelistcount_minyear
    Get the count for a list and year for a name
    Used to track uniquelist = minyear

  get_uniquelistcount_final
    Get the number of uniquelist entries for a full list

  reset_uniquelistcount
    Reset the count for list parts and complete lists

  reset_uniquenamecount
    Reset the list of names which have the name part in it

  get_basenamestring
  Get a basenamestring for a particular name

  get_namestring
  Get a namestring for a particular name

  get_namestrings
  Get namestrings for a particular name

  set_namedis
  Set name disambiguation metadata

  is_unbasepart
  Return boolean to say if a namepart is a base part according to
  template which created the information

  get_namehash
  Get hash for a name

  set_namehash
  Set hash for a name

  get_unmininfo
  Get uniquename minimalness info for a name

  set_unmininfo
  Set uniquename minimalness info for a name

  get_namedisschema
  Get a name disambiguation schema for a name

  get_unsummary
  Get legacy uniquename summary for a name

  get_unpart
  Get uniquename summary part for a name

  get_unparts
  Get uniquename parts for a name

  set_unparts
  Set uniquename parts for a name

  _get_uniquename
    Get the list of name contexts which contain a name
    Mainly for use in tests

  get_uniquename
  Get uniquename for a name

  set_uniquename
  Set uniquename for a name

  reset_uniquename
  Reset uniquename for a name

  get_uniquename_all
  Get uniquename for a name, regardless of visibility

  set_uniquename_all
  Set uniquename for a name, regardless of visibility

  count_uniquelist
    Count the names in a string used to determine uniquelist.

  get_uniquelist
  Gets a uniquelist setting for a namelist

  set_uniquelist
  Sets a uniquelist setting for a namelist

  get_visible_cite
  Gets citation name list visibility

  set_visible_cite
  Gets citation name list visibility

  get_visible_bib
  Gets bib name list visibility

  set_visible_bib
  Gets bib name list visibility

  get_visible_sort
  Gets sort name list visibility

  set_visible_sort
  Gets sort name list visibility

  get_visible_alpha
  Gets alpha name list visibility

  set_visible_alpha
  Gets alpha name list visibility

  get_numofuniquenames
    Get the number of uniquenames entries for a visible name

  get_numofuniquenames_all
    Get the number of uniquenames entries for a name

  get_unul_done
    Return a boolean saying whether uniquenename+uniquelist processing is finished

  set_unul_changed
    Set a boolean saying whether uniquename+uniquelist has changed

  reset_seen_extra
    Reset the counters for extra*

  incr_seen_extradate
    Increment and return the counter for extradate

  incr_seen_extraname
    Increment and return the counter for extraname

  incr_seen_labelname
    Increment and return a counter used to track extraname

  incr_seen_extratitle
    Increment and return the counter for extratitle

  incr_seen_extratitleyear
    Increment and return the counter for extratitleyear

  incr_seen_extraalpha
    Increment and return the counter for extraalpha

  get_seen_nametitledateparts
    Get the count of an labelname/dateparts combination for tracking
    extradate. It uses labelyear plus name as we need to disambiguate
    entries with different labelyear (like differentiating 1984--1986 from
    just 1984)

  incr_seen_nametitledateparts
    Increment the count of an labelname/labeltitle+dateparts combination for extradate

    We pass in the name/title and date strings separately as we have to
    be careful and only increment this counter beyond 1 if there is
    a name/title component. Otherwise, extradate gets defined for all
    entries with no name/title but the same year etc.

  get_seen_labelname
    Get the count of a labelname hash for tracking extraname

  get_seen_nametitle
    Get the count of an labelname/labeltitle combination for tracking
    extratitle.

  incr_seen_nametitle
    Increment the count of an labelname/labeltitle combination for extratitle

    We pass in the name and year strings separately as we have to
    be careful and only increment this counter beyond 1 if there is
    a title component. Otherwise, extratitle gets defined for all
    entries with no title.

  get_seen_titleyear
    Get the count of an labeltitle/labelyear combination for tracking
    extratitleyear

  incr_seen_titleyear
    Increment the count of an labeltitle/labelyear combination for extratitleyear

    We pass in the title and year strings separately as we have to
    be careful and only increment this counter beyond 1 if there is
    a title component. Otherwise, extratitleyear gets defined for all
    entries with no title.

  reset_workuniqueness
  Reset various work uniqueness counters

  get_seenname
    Get the count of occurrences of a labelname or labeltitle

  incr_seenname
    Increment the count of occurrences of a labelname or labeltitle

  get_seentitle
    Get the count of occurrences of a labeltitle

  incr_seentitle
    Increment the count of occurrences of a labeltitle

  get_seenbaretitle
    Get the count of occurrences of a labeltitle when there is
    no labelname

  incr_seenbaretitle
    Increment the count of occurrences of a labeltitle
    when there is no labelname

  get_seenwork
    Get the count of occurrences of a labelname and labeltitle

  incr_seenwork
    Increment the count of occurrences of a labelname and labeltitle

  incr_la_disambiguation
    Increment a counter to say we have seen this labelalpha

  get_la_disambiguation
    Get the disambiguation counter for this labelalpha.
    Return a 0 for undefs to avoid spurious errors.

  set_sortingtemplatename
    Sets the sortingtemplate name of a data list

  get_attrs
    Gets the attributes of a data list

  get_sortingtemplatename
    Gets the sortingtemplatename of a data list

  set_sortingnamekeytemplatename
    Sets the sortingnamekeytemplate name of a data list

  get_sortingnamekeytemplatename
    Gets the sortingnamekeytemplatename of a data list

  set_uniquenametemplatename
    Sets the uniquenametemplate name of a data list

  get_uniquenametemplatename
    Gets the uniquenametemplate name of a data list

  set_labelalphanametemplatename
    Sets the labelalphanametemplate name of a data list

  get_labelalphanametemplatename
    Gets the labelalphanametemplate name of a data list

  set_namehashtemplatename
    Sets the namehashtemplate name of a data list

  get_namehashtemplatename
    Gets the namehashtemplate name of a data list

  set_sortinit_collator
    Sets the sortinit collator for this list

  get_sortinit_collator
    Gets the sortinit collator for this list

  get_labelprefix
    Gets the labelprefix setting of a data list

  set_labelprefix
    Sets the labelprefix setting of a data list

  set_name
    Sets the name of a data list

  get_name
    Gets the name of a data list

  set_type
    Sets the type of a data list

  get_type
    Gets the type of a section list

  set_keys
    Sets the keys for the list

  get_keys
    Gets the keys for the list

  count_keys
    Count the keys for the list

  get_namelistdata
  Gets  name list data

  set_namelistdata
  Saves name list data

  get_labelalphadata
  Gets  labelalpha field data

  set_labelalphadata
  Saves labelalpha data

  get_labelalphadata_for_key
  Gets  labelalpha field data for a key

  set_labelalphadata_for_key
  Saves labelalpha field data for a key

  set_extradatedata_for_key
  Saves extradate field data for a key

  set_extranamedata_for_key
  Saves extraname field data for a key

  get_extranamedata_for_key
    Gets the extraname field data for a key

  set_extradatedata
    Saves extradate field data for all keys

  get_extradatedata_for_key
    Gets the extradate field data for a key

  set_extratitledata_for_key
  Saves extratitle field data for a key

  set_extratitledata
    Saves extratitle field data for all keys

  get_extratitledata
    Gets the extratitle field data for a key

  set_extratitleyeardata_for_key
  Saves extratitleyear field data for a key

  set_extratitleyeardata
    Saves extratitleyear field data for all keys

  get_extratitleyeardata
    Gets the extratitleyear field data for a key

  set_extraalphadata_for_key
    Saves extraalpha field data for a key

  set_extraalphadata
    Saves extraalpha field data for all keys

  get_extraalphadata
    Gets the extraalpha field data for a key

  get_sortdataschema
    Gets the sortdata schema for a sortlist

  set_sortdataschema
    Saves the sortdata schema for a sortlist

  set_sortdata
    Saves sorting data in a list for a key

  get_sortdata_for_key
    Gets the sorting data in a list for a key

  set_sortinitdata_for_key
 Saves sortinit data for a specific key

  set_sortinitdata
 Saves sortinit data for all keys

  get_sortinit_for_key
    Gets the sortinit in a list for a key

  set_sortingtemplate
    Sets the sortingtemplate of a list

  get_sortingtemplate
    Gets the sortingtemplate of a list

  add_filter
    Adds a filter to a list object

  get_filters
    Gets all filters for a list object

  instantiate_entry
  Do any dynamic information replacement for information
  which varies in an entry between lists. This is information which
  needs to be output to the .bbl for an entry but which is a property
  of the reference context and not the entry per se so it cannot be stored
  statically in the entry and must be retrieved from the specific datalist
  when outputting the entry.

  namelist_differs_index
    Returns the index where the name list begins to differ from any other list

    Assuming these lists

    [a, b]
    [a, b, d, e, f, g, h, i, j]
    [a, b, d, e, f]
    [a, b, e, z, z, y]

    namelist_differs_index([a, b, c, d, e]) -> 2
    namelist_differs_index([a]) -> 1

  namelist_differs_nth
    Returns true if some other name list differs at passed nth place
    and is at least as long

    namelist_differs_nth([a, b, c, d, e], 3) = 1

    if there is another name list like any of these:

    [a, b, d, e, f]
    [a, b, e, z, z, y]

AUTHORS
Philip Kime "<philip at kime.org.uk>"

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

COPYRIGHT & LICENSE
Copyright 2012-2024 Philip Kime, all rights reserved.

This module is free software. You can redistribute it and/or modify it under the terms of the Artistic License 2.0.

This program 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.