folia.main.Entity
=================

.. currentmodule:: folia.main

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

   

   
   .. rubric:: Method Summary

   .. autosummary::
   
      ~Entity.__init__
      ~Entity.accepts
      ~Entity.add
      ~Entity.addable
      ~Entity.addidsuffix
      ~Entity.addtoindex
      ~Entity.ancestor
      ~Entity.ancestors
      ~Entity.annotation
      ~Entity.annotations
      ~Entity.annotator2processor
      ~Entity.append
      ~Entity.checkdeclaration
      ~Entity.context
      ~Entity.copy
      ~Entity.copychildren
      ~Entity.correct
      ~Entity.count
      ~Entity.deepvalidation
      ~Entity.depthfirstsearch
      ~Entity.description
      ~Entity.elements
      ~Entity.feat
      ~Entity.findcorrectionhandling
      ~Entity.findreplaceables
      ~Entity.generate_id
      ~Entity.getindex
      ~Entity.getmetadata
      ~Entity.gettextdelimiter
      ~Entity.hasannotation
      ~Entity.hasphon
      ~Entity.hastag
      ~Entity.hastext
      ~Entity.incorrection
      ~Entity.insert
      ~Entity.items
      ~Entity.json
      ~Entity.layer
      ~Entity.leftcontext
      ~Entity.move
      ~Entity.next
      ~Entity.originaltext
      ~Entity.parsecommonarguments
      ~Entity.parsexml
      ~Entity.phon
      ~Entity.phoncontent
      ~Entity.postappend
      ~Entity.precedes
      ~Entity.previous
      ~Entity.relaxng
      ~Entity.relaxng_backwards
      ~Entity.remove
      ~Entity.replace
      ~Entity.resolveoffsets
      ~Entity.resolveword
      ~Entity.rightcontext
      ~Entity.select
      ~Entity.setdoc
      ~Entity.setdocument
      ~Entity.setparents
      ~Entity.setprocessor
      ~Entity.setspan
      ~Entity.settext
      ~Entity.sort
      ~Entity.speech_speaker
      ~Entity.speech_src
      ~Entity.stricttext
      ~Entity.substitute
      ~Entity.tag
      ~Entity.text
      ~Entity.textcontent
      ~Entity.textvalidation
      ~Entity.toktext
      ~Entity.untag
      ~Entity.updatetext
      ~Entity.wrefs
      ~Entity.xml
      ~Entity.xmlstring
    
    
    ~Entity.__iter__
    
    
    
    ~Entity.__len__
    
    
    
    ~Entity.__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:: 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:: hasphon
   
   .. automethod:: hastag
   
   .. automethod:: hastext
   
   .. automethod:: incorrection
   
   .. automethod:: insert
   
   .. automethod:: items
   
   .. automethod:: json
   
   .. automethod:: layer
   
   .. automethod:: leftcontext
   
   .. automethod:: move
   
   .. automethod:: next
   
   .. automethod:: originaltext
   
   .. automethod:: parsecommonarguments
   
   .. automethod:: parsexml
   
   .. automethod:: phon
   
   .. automethod:: phoncontent
   
   .. automethod:: postappend
   
   .. automethod:: precedes
   
   .. automethod:: previous
   
   .. automethod:: relaxng
   
   .. automethod:: relaxng_backwards
   
   .. automethod:: remove
   
   .. automethod:: replace
   
   .. automethod:: resolveoffsets
   
   .. automethod:: resolveword
   
   .. automethod:: rightcontext
   
   .. automethod:: select
   
   .. automethod:: setdoc
   
   .. automethod:: setdocument
   
   .. automethod:: setparents
   
   .. automethod:: setprocessor
   
   .. automethod:: setspan
   
   .. automethod:: settext
   
   .. automethod:: sort
   
   .. 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:: wrefs
   
   .. automethod:: xml
   
   .. automethod:: xmlstring
   
   
   
   .. automethod:: __iter__
   
   
   
   .. automethod:: __len__
   
   
   
   .. automethod:: __str__