folia.main.Reference
====================

.. currentmodule:: folia.main

.. autoclass:: Reference
   :show-inheritance:
   :undoc-members:
   :special-members:

   

   
   .. rubric:: Method Summary

   .. autosummary::
   
      ~Reference.__init__
      ~Reference.accepts
      ~Reference.add
      ~Reference.addable
      ~Reference.addidsuffix
      ~Reference.addtoindex
      ~Reference.alternatives
      ~Reference.ancestor
      ~Reference.ancestors
      ~Reference.annotation
      ~Reference.annotations
      ~Reference.annotator2processor
      ~Reference.append
      ~Reference.checkdeclaration
      ~Reference.context
      ~Reference.copy
      ~Reference.copychildren
      ~Reference.correct
      ~Reference.count
      ~Reference.deepvalidation
      ~Reference.depthfirstsearch
      ~Reference.description
      ~Reference.elements
      ~Reference.feat
      ~Reference.findcorrectionhandling
      ~Reference.findreplaceables
      ~Reference.generate_id
      ~Reference.getindex
      ~Reference.getmetadata
      ~Reference.gettextdelimiter
      ~Reference.hasannotation
      ~Reference.hasannotationlayer
      ~Reference.hasphon
      ~Reference.hastag
      ~Reference.hastext
      ~Reference.incorrection
      ~Reference.insert
      ~Reference.items
      ~Reference.json
      ~Reference.layers
      ~Reference.leftcontext
      ~Reference.move
      ~Reference.next
      ~Reference.originaltext
      ~Reference.paragraphs
      ~Reference.parsecommonarguments
      ~Reference.parsexml
      ~Reference.phon
      ~Reference.phoncontent
      ~Reference.postappend
      ~Reference.precedes
      ~Reference.previous
      ~Reference.relaxng
      ~Reference.relaxng_backwards
      ~Reference.remove
      ~Reference.replace
      ~Reference.resolve
      ~Reference.resolveoffsets
      ~Reference.resolveword
      ~Reference.rightcontext
      ~Reference.select
      ~Reference.sentences
      ~Reference.setdoc
      ~Reference.setdocument
      ~Reference.setparents
      ~Reference.setprocessor
      ~Reference.settext
      ~Reference.speech_speaker
      ~Reference.speech_src
      ~Reference.stricttext
      ~Reference.substitute
      ~Reference.tag
      ~Reference.text
      ~Reference.textcontent
      ~Reference.textvalidation
      ~Reference.toktext
      ~Reference.untag
      ~Reference.updatetext
      ~Reference.words
      ~Reference.xml
      ~Reference.xmlstring
    
    
    ~Reference.__iter__
    
    
    
    ~Reference.__len__
    
    
    
    ~Reference.__str__
    
    
   
   

   
   
   .. rubric:: Class Attributes

   
   .. autoattribute:: ACCEPTED_DATA
   .. autoattribute:: ANNOTATIONTYPE
   .. autoattribute:: AUTH
   .. autoattribute:: AUTO_GENERATE_ID
   .. autoattribute:: HIDDEN
   .. autoattribute:: IMPLICITSPACE
   .. autoattribute:: LABEL
   .. autoattribute:: OCCURRENCES
   .. autoattribute:: OCCURRENCES_PER_SET
   .. autoattribute:: OPTIONAL_ATTRIBS
   .. autoattribute:: PHONCONTAINER
   .. autoattribute:: PRIMARYELEMENT
   .. autoattribute:: PRINTABLE
   .. autoattribute:: REQUIRED_ATTRIBS
   .. autoattribute:: REQUIRED_DATA
   .. autoattribute:: SETONLY
   .. autoattribute:: SPEAKABLE
   .. autoattribute:: SUBSET
   .. autoattribute:: TEXTCONTAINER
   .. autoattribute:: TEXTDELIMITER
   .. autoattribute:: WREFABLE
   .. autoattribute:: XLINK
   .. autoattribute:: XMLTAG
   
   

   .. rubric:: Method Details

   .. automethod::  __init__
   
   .. automethod:: __init__
   
   .. automethod:: accepts
   
   .. automethod:: add
   
   .. automethod:: addable
   
   .. automethod:: addidsuffix
   
   .. automethod:: addtoindex
   
   .. automethod:: alternatives
   
   .. automethod:: ancestor
   
   .. automethod:: ancestors
   
   .. automethod:: annotation
   
   .. automethod:: annotations
   
   .. automethod:: annotator2processor
   
   .. automethod:: append
   
   .. automethod:: checkdeclaration
   
   .. automethod:: context
   
   .. automethod:: copy
   
   .. automethod:: copychildren
   
   .. automethod:: correct
   
   .. automethod:: count
   
   .. automethod:: deepvalidation
   
   .. automethod:: depthfirstsearch
   
   .. automethod:: description
   
   .. automethod:: elements
   
   .. automethod:: feat
   
   .. automethod:: findcorrectionhandling
   
   .. automethod:: findreplaceables
   
   .. automethod:: generate_id
   
   .. automethod:: getindex
   
   .. automethod:: getmetadata
   
   .. automethod:: gettextdelimiter
   
   .. automethod:: hasannotation
   
   .. automethod:: hasannotationlayer
   
   .. automethod:: hasphon
   
   .. automethod:: hastag
   
   .. automethod:: hastext
   
   .. automethod:: incorrection
   
   .. automethod:: insert
   
   .. automethod:: items
   
   .. automethod:: json
   
   .. automethod:: layers
   
   .. automethod:: leftcontext
   
   .. automethod:: move
   
   .. automethod:: next
   
   .. automethod:: originaltext
   
   .. automethod:: paragraphs
   
   .. automethod:: parsecommonarguments
   
   .. automethod:: parsexml
   
   .. automethod:: phon
   
   .. automethod:: phoncontent
   
   .. automethod:: postappend
   
   .. automethod:: precedes
   
   .. automethod:: previous
   
   .. automethod:: relaxng
   
   .. automethod:: relaxng_backwards
   
   .. automethod:: remove
   
   .. automethod:: replace
   
   .. automethod:: resolve
   
   .. automethod:: resolveoffsets
   
   .. automethod:: resolveword
   
   .. automethod:: rightcontext
   
   .. automethod:: select
   
   .. automethod:: sentences
   
   .. automethod:: setdoc
   
   .. automethod:: setdocument
   
   .. automethod:: setparents
   
   .. automethod:: setprocessor
   
   .. automethod:: settext
   
   .. automethod:: speech_speaker
   
   .. automethod:: speech_src
   
   .. automethod:: stricttext
   
   .. automethod:: substitute
   
   .. automethod:: tag
   
   .. automethod:: text
   
   .. automethod:: textcontent
   
   .. automethod:: textvalidation
   
   .. automethod:: toktext
   
   .. automethod:: untag
   
   .. automethod:: updatetext
   
   .. automethod:: words
   
   .. automethod:: xml
   
   .. automethod:: xmlstring
   
   
   
   .. automethod:: __iter__
   
   
   
   .. automethod:: __len__
   
   
   
   .. automethod:: __str__