Python LMF library
 All Classes Namespaces Files Functions Variables
Public Member Functions | Public Attributes | List of all members
pylmflib.pylmflib.core.lexical_entry.LexicalEntry Class Reference

"Lexical Entry is a class representing a lexeme in a given language and is a container for managing the Form and Sense classes. A Lexical Entry instance can contain one to many different forms and can have from zero to many different senses." (LMF) More...

Public Member Functions

def __init__
 Constructor. More...
 
def __del__
 Destructor. More...
 
def set_partOfSpeech
 Set grammatical category. More...
 
def get_partOfSpeech
 Get grammatical category. More...
 
def set_status
 Set lexical entry status. More...
 
def get_status
 Get lexical entry status. More...
 
def set_date
 Set lexical entry date. More...
 
def get_date
 Get lexical entry date. More...
 
def set_homonymNumber
 Set lexical entry homonym number. More...
 
def get_homonymNumber
 Get lexical entry homonym number. More...
 
def set_bibliography
 Set lexical entry bibliography. More...
 
def get_bibliography
 Get lexical entry bibliography. More...
 
def set_independentWord
 Set lexical entry independent word indication. More...
 
def get_independentWord
 Get lexical entry independent word indication. More...
 
def get_id
 Get Unique IDentifier. More...
 
def set_lexeme
 Set lexeme. More...
 
def get_lexeme
 Get lexeme. More...
 
def create_related_form
 Create a related form. More...
 
def add_related_form
 Add a related form to the lexical entry. More...
 
def create_and_add_related_form
 Create and add a related form to the lexical entry. More...
 
def find_related_forms
 Find related lexemes. More...
 
def get_related_forms
 Get all related forms maintained by the lexical entry. More...
 
def get_last_related_form
 Get the previously registered related form. More...
 
def get_form_representations
 Get all form representations maintained by the lemma. More...
 
def set_variant_form
 Set variant form and type. More...
 
def get_variant_forms
 Get all variant forms of specified type. More...
 
def set_variant_comment
 Set variant comment and language. More...
 
def set_tone
 Set tone. More...
 
def get_tones
 Get all tones. More...
 
def set_geographical_variant
 Set geographical variant. More...
 
def set_phonetic_form
 Set phonetic form. More...
 
def get_phonetic_forms
 Get all phonetic forms. More...
 
def set_contextual_variation
 Set contextual variation. More...
 
def get_contextual_variations
 Get all contextual variations. More...
 
def set_spelling_variant
 Set spelling variant. More...
 
def get_spelling_variants
 Get all spelling variants. More...
 
def set_citation_form
 Set citation form. More...
 
def get_citation_forms
 Get all citation forms. More...
 
def set_dialect
 Set dialect. More...
 
def set_transliteration
 Set transliteration. More...
 
def get_transliterations
 Get all transliterations. More...
 
def set_script_name
 Set script name. More...
 
def create_sense
 Create a sense. More...
 
def add_sense
 Add a sense to the lexical entry. More...
 
def create_and_add_sense
 Create and add a sense to the lexical entry. More...
 
def get_senses
 Get all senses maintained by the lexical entry. More...
 
def get_last_sense
 Get the previously registered sense. More...
 
def set_definition
 Set definition and language. More...
 
def set_gloss
 Set gloss and language. More...
 
def set_note
 Set note, type and language. More...
 
def find_notes
 Find notes. More...
 
def set_usage_note
 Set usage note and language. More...
 
def set_encyclopedic_information
 Set encyclopedic information and language. More...
 
def set_restriction
 Set restriction and language. More...
 
def set_borrowed_word
 Set source language (in English). More...
 
def get_borrowed_word
 Get source language (in English). More...
 
def set_written_form
 Set loan word. More...
 
def get_written_form
 Get loan word. More...
 
def set_etymology
 Set etymology. More...
 
def get_etymology
 Get etymology. More...
 
def set_etymology_comment
 Set etymology comment and language. More...
 
def get_etymology_comment
 Get etymology comment. More...
 
def get_term_source_language
 Get language used for the etymology comment. More...
 
def set_etymology_gloss
 Set etymology gloss. More...
 
def get_etymology_gloss
 Get etymology gloss. More...
 
def set_etymology_source
 Set etymology source. More...
 
def get_etymology_source
 Get etymology source. More...
 
def set_scientific_name
 Set scientific_name. More...
 
def get_scientific_name
 Get scientific name. More...
 
def create_word_form
 Create a word form. More...
 
def add_word_form
 Add a word form to the lexical entry. More...
 
def get_word_forms
 Get all word forms maintained by the lexical entry. More...
 
def set_paradigm
 Set paradigm. More...
 
def find_paradigms
 Find paradigms. More...
 
def set_paradigm_label
 Set paradigm label. More...
 
def set_paradigm_form
 Set paradigm form. More...
 
def set_morphology
 Set morphology. More...
 
def get_paradigms
 Get all paradigms. More...
 
def get_morphologies
 Get all morphologies. More...
 
def create_example
 Create a context. More...
 
def create_and_add_example
 Add an example to a new context and set its written form, language and script. More...
 
def add_example
 Add an example to an existing context and set its written form, language and script. More...
 
def set_example_comment
 Set comment of an existing example. More...
 
def set_semantic_domain
 Set semantic domain and language. More...
 
def get_semantic_domains
 Get all semantic domains. More...
 
def set_translation
 Set translation and language. More...
 
def set_audio
 Set audio resource. More...
 
def is_subentry
 Check if this lexical entry is a subentry. More...
 
def has_subentries
 Check if this lexical entry has subentries. More...
 
def get_subentries
 Get subentries of this lexical entry. More...
 
def get_main_entry
 If this lexical entry is a subentry, get its main entry. More...
 
def create_and_add_component
 Create and add a component to the lexical entry. More...
 
def get_components
 If this lexical entry is a multiword expression, get its components. More...
 
def is_component
 Check if this lexical entry is a component. More...
 
def get_speaker
 Get speaker. More...
 

Public Attributes

 homonymNumber
 
 status
 
 date
 
 partOfSpeech
 
 independentWord
 
 bibliography
 
 id
 UID is managed at the Lexicon level. More...
 
 sense
 Sense instances are owned by LexicalEntry There is zero to many Sense instances per LexicalEntry. More...
 
 lemma
 Lemma instance is owned by LexicalEntry There is one Lemma instance by LexicalEntry instance. More...
 
 related_form
 RelatedForm instances are owned by LexicalEntry There is zero to many RelatedForm instances per LexicalEntry. More...
 
 word_form
 WordForm instances are owned by LexicalEntry There is zero to many WordForm instances per LexicalEntry. More...
 
 stem
 Stem instances are owned by LexicalEntry There is zero to many Stem instances per LexicalEntry. More...
 
 list_of_components
 ListOfComponents instance is owned by LexicalEntry There is zero or one ListOfComponents instance per LexicalEntry. More...
 
 targets
 

Detailed Description

"Lexical Entry is a class representing a lexeme in a given language and is a container for managing the Form and Sense classes. A Lexical Entry instance can contain one to many different forms and can have from zero to many different senses." (LMF)

Definition at line 15 of file lexical_entry.py.

Constructor & Destructor Documentation

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.__init__ (   self,
  id = '0' 
)

Constructor.

LexicalEntry instances are owned by Lexicon.

Parameters
idUnique IDentifier. If not provided, default value is 0.
Returns
A LexicalEntry instance.

Definition at line 18 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.__del__ (   self)

Destructor.

Release Sense, Lemma, RelatedForm, WordForm, Stem, ListOfComponents instances.

Definition at line 56 of file lexical_entry.py.

Member Function Documentation

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.add_example (   self,
  written_form,
  language = None,
  script_name = None 
)

Add an example to an existing context and set its written form, language and script.

Attributes 'writtenForm', 'language' and 'scriptName' are owned by TextRepresentation, which is owned by Context, itself owend by Sense.

Parameters
written_formThe written form to set.
languageLanguage used for the written form.
script_nameThe name of the script used to write the example, e.g. devanagari.
Returns
LexicalEntry instance.

Definition at line 975 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.add_related_form (   self,
  related_form 
)

Add a related form to the lexical entry.

Parameters
related_formThe RelatedForm instance to add to the lexical entry.
Returns
LexicalEntry instance.

Definition at line 209 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.add_sense (   self,
  sense 
)

Add a sense to the lexical entry.

Parameters
senseThe Sense instance to add to the lexical entry.
Returns
LexicalEntry instance.

Definition at line 472 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.add_word_form (   self,
  word_form 
)

Add a word form to the lexical entry.

Parameters
word_formThe WordForm instance to add to the lexical entry.
Returns
LexicalEntry instance.

Definition at line 808 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.create_and_add_component (   self,
  position,
  lexeme 
)

Create and add a component to the lexical entry.

Parameters
positionThe position of the component in the multiword expression.
lexemeRelated lexeme.
Returns
LexicalEntry instance.

Definition at line 1110 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.create_and_add_example (   self,
  written_form,
  language = None,
  script_name = None 
)

Add an example to a new context and set its written form, language and script.

Attributes 'writtenForm', 'language' and 'scriptName' are owned by TextRepresentation, which is owned by Context, itself owend by Sense.

Parameters
written_formThe written form to set.
languageLanguage used for the written form.
script_nameThe name of the script used to write the example, e.g. devanagari.
Returns
LexicalEntry instance.

Definition at line 958 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.create_and_add_related_form (   self,
  lexeme,
  semantic_relation 
)

Create and add a related form to the lexical entry.

Parameters
lexemeRelated lexeme.
semantic_relationThe semantic relation existing between this lexical entry and the related lexeme to create.
Returns
LexicalEntry instance.

Definition at line 217 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.create_and_add_sense (   self,
  sense_number 
)

Create and add a sense to the lexical entry.

Parameters
sense_numberNumber of the sense to add.
Returns
LexicalEntry instance.

Definition at line 480 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.create_example (   self,
  reference = None 
)

Create a context.

Attribute 'targets' is owned by Context, itself owend by Sense.

Parameters
referenceThe example reference to set. If not provided, default value is None.
Returns
LexicalEntry instance.

Definition at line 943 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.create_related_form (   self,
  lexeme,
  semantic_relation 
)

Create a related form.

Parameters
lexemeRelated lexeme.
semantic_relationThe semantic relation existing between this lexical entry and the related lexeme to create.
Returns
RelatedForm instance.

Definition at line 201 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.create_sense (   self,
  id = 0 
)

Create a sense.

Parameters
idIdentifier.
Returns
Sense instance.

Definition at line 465 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.create_word_form (   self)

Create a word form.

Returns
WordForm instance.

Definition at line 802 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.find_notes (   self,
  type,
  language = None 
)

Find notes.

This attribute is owned by Statement, which owned by Definition, itself owned by Sense.

Parameters
typeType of the note to consider to retrieve the note.
languageIf this argument is given, find note only if written in this language.
Returns
A Python list of found Statement attributes 'notes'.

Definition at line 551 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.find_paradigms (   self,
  script_name = None,
  person = None,
  anymacy = None,
  grammatical_number = None,
  clusivity = None 
)

Find paradigms.

Attribute 'scriptName' is owned by FormRepresentation, wich is owned by WordForm. Attributes 'person', 'anymacy', 'grammaticalNumber' and 'clusivity' are owned by WordForm. Attribute 'writtenForm' to retrieve is owned by FormRepresentation, wich is owned by WordForm.

Parameters
script_nameIf this argument is given, get paradigm written form only if written using this script.
personPerson, e.g. first person.
anymacyAnymacy, e.g. animate or inanimate.
grammatical_numberGrammatical number, e.g. singular or plural.
clusivityClusivity, e.g. inclusive or exclusive.
Returns
A Python list of FormRepresentation attributes 'writtenForm'.

Definition at line 856 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.find_related_forms (   self,
  semantic_relation 
)

Find related lexemes.

This attribute is owned by RelatedForm.

Parameters
semantic_relationThe semantic relation to consider to retrieve the related form.
Returns
A Python list of found RelatedForm attributes 'targets'.

Definition at line 230 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.get_bibliography (   self)

Get lexical entry bibliography.

Returns
LexicalEntry attribute 'bibliography'.

Definition at line 150 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.get_borrowed_word (   self)

Get source language (in English).

This attribute is owned by Statement, which is owned by Definition, itself owned by Sense.

Returns
Statement attribute 'borrowedWord'.

Definition at line 626 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.get_citation_forms (   self,
  script_name = None 
)

Get all citation forms.

Attribute 'citationForm' is owned by FormRepresentation, which is owned by Lemma.

Parameters
script_nameIf provided, get only citation forms that are written using this script.
Returns
A Python list of FormRepresentation attributes 'citationForm' if any.

Definition at line 412 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.get_components (   self)

If this lexical entry is a multiword expression, get its components.

Returns
A list of components if any, an empty list otherwise.

Definition at line 1121 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.get_contextual_variations (   self)

Get all contextual variations.

Attribute 'contextualVariation' is owned by FormRepresentation, which is owned by Lemma.

Returns
A Python list of FormRepresentation attributes 'contextualVariation' if any.

Definition at line 371 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.get_date (   self)

Get lexical entry date.

Returns
LexicalEntry attribute 'date'.

Definition at line 122 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.get_etymology (   self)

Get etymology.

This attribute is owned by Statement, which is owned by Definition, itself owned by Sense.

Returns
The first found Statement attribute 'etymology'.

Definition at line 678 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.get_etymology_comment (   self,
  term_source_language = None 
)

Get etymology comment.

This attribute is owned by Statement, which is owned by Definition, itself owned by Sense.

Parameters
term_source_languageThe language of the etymology comment to retrieve.
Returns
The first found Statement attribute 'etymologyComment'.

Definition at line 703 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.get_etymology_gloss (   self)

Get etymology gloss.

This attribute is owned by Statement, which is owned by Definition, itself owned by Sense.

Returns
Statement attribute 'etymologyGloss'.

Definition at line 739 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.get_etymology_source (   self)

Get etymology source.

This attribute is owned by Statement, which is owned by Definition, itself owned by Sense.

Returns
Statement attribute 'etymologySource'.

Definition at line 765 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.get_form_representations (   self)

Get all form representations maintained by the lemma.

Attribute 'form_representation' is owned by Lemma.

Returns
Lemma attribute 'form_representation' if any.

Definition at line 263 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.get_homonymNumber (   self)

Get lexical entry homonym number.

Returns
LexicalEntry attribute 'homonymNumber'.

Definition at line 136 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.get_id (   self)

Get Unique IDentifier.

Returns
LexicalEntry attribute 'id' followed by the homonym number.

Definition at line 172 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.get_independentWord (   self)

Get lexical entry independent word indication.

Returns
LexicalEntry attribute 'independentWord'.

Definition at line 166 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.get_last_related_form (   self,
  semantic_relation = None 
)

Get the previously registered related form.

Parameters
semantic_relationThe semantic relation to consider to retrieve the last related form.
Returns
The last element of LexicalEntry attribute 'related_form' that matches with semantic relation if provided.

Definition at line 255 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.get_last_sense (   self)

Get the previously registered sense.

Returns
The last element of LexicalEntry attribute 'sense'.

Definition at line 495 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.get_lexeme (   self)

Get lexeme.

Attribute 'lexeme' is owned by Lemma.

Returns
Lemma attribute 'lexeme' if any.

Definition at line 193 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.get_main_entry (   self)

If this lexical entry is a subentry, get its main entry.

Returns
A LexicalEntry if it exists, 'None' otherwise.

Definition at line 1102 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.get_morphologies (   self)

Get all morphologies.

This attribute is owned by Paradigm, which is owned by Sense.

Returns
A Python list of Paradigm attributes 'morphology'.

Definition at line 931 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.get_paradigms (   self)

Get all paradigms.

This attribute is owned by Sense.

Returns
Sense attribute 'paradigm'.

Definition at line 921 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.get_partOfSpeech (   self)

Get grammatical category.

Returns
LexicalEntry attribute 'partOfSpeech'.

Definition at line 94 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.get_phonetic_forms (   self,
  script_name = None 
)

Get all phonetic forms.

Attribute 'phoneticForm' is owned by FormRepresentation, which is owned by Lemma.

Parameters
script_nameIf provided, get only phonetic forms that are written using this script.
Returns
A Python list of FormRepresentation attributes 'phoneticForm' if any.

Definition at line 350 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.get_related_forms (   self,
  semantic_relation = None 
)

Get all related forms maintained by the lexical entry.

Parameters
semantic_relationThe semantic relation to consider to retrieve the related forms.
Returns
A Python set of related forms.

Definition at line 242 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.get_scientific_name (   self)

Get scientific name.

This attribute is owned by Statement, which is owned by Definition, itself owned by Sense.

Returns
Statement attribute 'scientificName'.

Definition at line 791 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.get_semantic_domains (   self,
  language = None 
)

Get all semantic domains.

This attribute is owned by SubjectField, which is owned by Sense.

Parameters
languageIf this argument is given, get only semantic domains that are described using this language.
Returns
A Python list of filtered SubjectField attributes 'semanticDomain'.

Definition at line 1023 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.get_senses (   self)

Get all senses maintained by the lexical entry.

Returns
LexicalEntry attribute 'sense'.

Definition at line 489 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.get_speaker (   self)

Get speaker.

Returns
LexicalEntry private attribute '__speaker'.

Definition at line 1139 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.get_spelling_variants (   self)

Get all spelling variants.

Attribute 'spellingVariant' is owned by FormRepresentation, which is owned by Lemma.

Returns
A Python list of FormRepresentation attributes 'spellingVariant' if any.

Definition at line 391 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.get_status (   self)

Get lexical entry status.

Returns
LexicalEntry attribute 'status'.

Definition at line 108 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.get_subentries (   self)

Get subentries of this lexical entry.

Returns
A Python list of LexicalEntry.

Definition at line 1092 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.get_term_source_language (   self)

Get language used for the etymology comment.

This attribute is owned by Statement, which is owned by Definition, itself owned by Sense.

Returns
Statement attribute 'termSourceLanguage'.

Definition at line 713 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.get_tones (   self)

Get all tones.

Attribute 'tone' is owned by FormRepresentation, which is owned by Lemma.

Returns
A Python list of FormRepresentation attributes 'tone' if any.

Definition at line 317 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.get_transliterations (   self)

Get all transliterations.

Attribute 'transliteration' is owned by FormRepresentation, which is owned by Lemma.

Returns
A Python list of FormRepresentation attributes 'transliteration' if any.

Definition at line 445 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.get_variant_forms (   self,
  type = "unspecified" 
)

Get all variant forms of specified type.

Attribute 'variantForm' is owned by FormRepresentation, which is owned by Lemma.

Returns
A Python list of FormRepresentation attributes 'variantForm' if type matches.

Definition at line 284 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.get_word_forms (   self)

Get all word forms maintained by the lexical entry.

Returns
A Python list of word forms.

Definition at line 816 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.get_written_form (   self)

Get loan word.

This attribute is owned by Statement, which is owned by Definition, itself owned by Sense.

Returns
Statement attribute 'writtenForm'.

Definition at line 652 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.has_subentries (   self)

Check if this lexical entry has subentries.

Returns
'True' if it has subentries, 'False' otherwise.

Definition at line 1082 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.is_component (   self)

Check if this lexical entry is a component.

Returns
'True' if it is a component, 'False' otherwise.

Definition at line 1129 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.is_subentry (   self)

Check if this lexical entry is a subentry.

Returns
'True' if it is a subentry, 'False' otherwise.

Definition at line 1072 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.set_audio (   self,
  media_type = "audio",
  file_name = None,
  author = None,
  quality = None,
  start_position = "T00:00:00",
  duration = None,
  external_reference = None,
  audio_file_format = None 
)

Set audio resource.

Attributes 'mediaType', 'fileName', 'author', 'quality', 'startPosition', 'durationOfEffectiveSpeech', 'externalReference', 'audioFileFormat' are owned by Material/Audio, which is owned by FormRepresentation, itself owend by Lemma.

Parameters
media_typeThe media type to set.
file_nameName of the audio file.
authorAuthor of the recording.
qualityQuality of the recording, in range 'quality_range' defined in 'common/range.py'.
start_positionStart position of the form in the recording, in format 'Thh:mm:ss,msms', e.g. "T00:05:00".
durationDuration of the effcetive speech, in format 'PThhHmmMssS', e.g. "PT00:05:00".
external_referenceReference of the audio file, if not directly provided.
audio_file_formatFormat of the audio file, e.g. "wav".
Returns
LexicalEntry instance.

Definition at line 1053 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.set_bibliography (   self,
  bibliography 
)

Set lexical entry bibliography.

Parameters
bibliographyThe bibliography to set.
Returns
LexicalEntry instance.

Definition at line 142 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.set_borrowed_word (   self,
  borrowed_word 
)

Set source language (in English).

Attribute 'borrowedWord' is owned by Statement, which is owned by Definition, itself owned by Sense.

Parameters
borrowed_wordSource language.
Returns
LexicalEntry instance.

Definition at line 611 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.set_citation_form (   self,
  citation_form,
  script_name = None 
)

Set citation form.

Attribute 'citationForm' is owned by FormRepresentation, which is owned by Lemma.

Parameters
citation_formThe citation form to set.
script_nameThe name of the script used to write the citation form, e.g. devanagari.
Returns
LexicalEntry instance.

Definition at line 399 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.set_contextual_variation (   self,
  contextual_variation 
)

Set contextual variation.

Attribute 'contextualVariation' is owned by FormRepresentation, which is owned by Lemma.

Parameters
contextual_variationThe contextual variation to set.
Returns
LexicalEntry instance.

Definition at line 359 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.set_date (   self,
  date 
)

Set lexical entry date.

Parameters
statusThe date to set.
Returns
LexicalEntry instance.

Definition at line 114 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.set_definition (   self,
  definition,
  language = None 
)

Set definition and language.

Attributes 'definition' and 'language' are owned by Definition, which is owned by Sense.

Parameters
definitionDefinition.
languageLanguage of definition.
Returns
LexicalEntry instance.

Definition at line 502 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.set_dialect (   self,
  dialect 
)

Set dialect.

Attribute 'dialect' is owned by FormRepresentation, which is owned by Lemma.

Parameters
dialectThe dialect to set.
Returns
LexicalEntry instance.

Definition at line 421 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.set_encyclopedic_information (   self,
  encyclopedic_information,
  language = None 
)

Set encyclopedic information and language.

Attributes 'encyclopedicInformation' and 'language' are owned by Statement, which owned by Definition, itself owned by Sense.

Parameters
encyclopedic_informationEncyclopedic information to set.
languageLanguage of the encyclopedic information.
Returns
LexicalEntry instance.

Definition at line 579 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.set_etymology (   self,
  etymology 
)

Set etymology.

Attribute 'etymology' is owned by Statement, which is owned by Definition, itself owned by Sense.

Parameters
etymologyEtymology.
Returns
LexicalEntry instance.

Definition at line 663 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.set_etymology_comment (   self,
  etymology_comment,
  term_source_language = None 
)

Set etymology comment and language.

Attributes 'etymologyComment' and 'termSourceLanguage' are owned by Statement, which is owned by Definition, itself owned by Sense.

Parameters
etymology_commentEtymology comment.
term_source_languageLanguage of the comment.
Returns
LexicalEntry instance.

Definition at line 687 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.set_etymology_gloss (   self,
  etymology_gloss 
)

Set etymology gloss.

Attribute 'etymologyGloss' is owned by Statement, which is owned by Definition, itself owned by Sense.

Parameters
etymology_glossEtymology gloss.
Returns
LexicalEntry instance.

Definition at line 724 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.set_etymology_source (   self,
  etymology_source 
)

Set etymology source.

Attribute 'etymologySource' is owned by Statement, which is owned by Definition, itself owned by Sense.

Parameters
etymology_sourceEtymology source.
Returns
LexicalEntry instance.

Definition at line 750 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.set_example_comment (   self,
  comment 
)

Set comment of an existing example.

Attribute 'comment' is owned by TextRepresentation, which is owned by Context, itself owend by Sense.

Parameters
commentThe comment to set.
Returns
LexicalEntry instance.

Definition at line 992 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.set_geographical_variant (   self,
  geographical_variant 
)

Set geographical variant.

Attribute 'geographicalVariant' is owned by FormRepresentation, which is owned by Lemma.

Parameters
geographical_variantThe geographical variant to set.
Returns
LexicalEntry instance.

Definition at line 325 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.set_gloss (   self,
  gloss,
  language = None 
)

Set gloss and language.

Attributes 'gloss' and 'language' are owned by Definition, which is owned by Sense.

Parameters
glossGloss.
languageLanguage of gloss.
Returns
LexicalEntry instance.

Definition at line 518 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.set_homonymNumber (   self,
  homonym_number 
)

Set lexical entry homonym number.

Parameters
homonym_numberThe homonym number to set.
Returns
LexicalEntry instance.

Definition at line 128 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.set_independentWord (   self,
  independent_word 
)

Set lexical entry independent word indication.

Parameters
independent_wordThe independent word indication to set.
Returns
LexicalEntry instance.

Definition at line 156 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.set_lexeme (   self,
  lexeme 
)

Set lexeme.

Attribute 'lexeme' is owned by Lemma.

Parameters
lexemeThe lexeme to set.
Returns
LexicalEntry instance.

Definition at line 181 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.set_morphology (   self,
  morphology 
)

Set morphology.

Attribute 'morphology' is owned by Paradigm, which is owned by Sense.

Parameters
morphologyMorphology.
Returns
LexicalEntry instance.

Definition at line 906 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.set_note (   self,
  note,
  type = None,
  language = None 
)

Set note, type and language.

Attributes 'note', 'noteType' and 'language' are owned by Statement, which owned by Definition, itself owned by Sense.

Parameters
noteNote to set.
typeType of the note.
languageLanguage of the note.
Returns
LexicalEntry instance.

Definition at line 534 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.set_paradigm (   self,
  written_form,
  script_name = None,
  person = None,
  anymacy = None,
  grammatical_number = None,
  clusivity = None 
)

Set paradigm.

Attributes 'writtenForm' and 'scriptName' are owned by FormRepresentation, wich is owned by WordForm. Attributes 'person', 'anymacy', 'grammaticalNumber' and 'clusivity' are owned by WordForm.

Parameters
written_formThe paradigm to set.
script_nameScript used for the written form.
personPerson, e.g. first person.
anymacyAnymacy, e.g. animate or inanimate.
grammatical_numberGrammatical number, e.g. singular or plural.
clusivityClusivity, e.g. inclusive or exclusive.
Returns
LexicalEntry instance.

Definition at line 822 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.set_paradigm_form (   self,
  paradigm,
  language = None 
)

Set paradigm form.

Attribute 'paradigm' is owned by Paradigm, which is owned by Sense.

Parameters
paradigmParadigm form.
languageLanguage of the paradigm form.
Returns
LexicalEntry instance.

Definition at line 890 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.set_paradigm_label (   self,
  paradigm_label 
)

Set paradigm label.

Attribute 'paradigmLabel' is owned by Paradigm, which is owned by Sense.

Parameters
paradigm_labelParadigm label.
Returns
LexicalEntry instance.

Definition at line 875 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.set_partOfSpeech (   self,
  part_of_speech,
  range = partOfSpeech_range,
  mapping = ps_partOfSpeech 
)

Set grammatical category.

Parameters
part_of_speechThe grammatical category to set.
rangeA Python set giving all possible values of part of speech LMF attribute.
mappingA Python dictionary giving the mapping between MDF and LMF values.
Returns
LexicalEntry instance.

Definition at line 79 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.set_phonetic_form (   self,
  phonetic_form,
  script_name = None 
)

Set phonetic form.

Attribute 'phoneticForm' is owned by FormRepresentation, which is owned by Lemma.

Parameters
phonetic_formThe phonetic form to set.
script_nameThe name of the script used to write the phonetic form, e.g. pinyin.
Returns
LexicalEntry instance.

Definition at line 337 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.set_restriction (   self,
  restriction,
  language = None 
)

Set restriction and language.

Attributes 'restriction' and 'language' are owned by Statement, which owned by Definition, itself owned by Sense.

Parameters
restrictionRestriction to set.
languageLanguage of the restriction.
Returns
LexicalEntry instance.

Definition at line 595 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.set_scientific_name (   self,
  scientific_name 
)

Set scientific_name.

Attribute 'scientificName' is owned by Statement, which is owned by Definition, itself owned by Sense.

Parameters
scientific_nameScientific name.
Returns
LexicalEntry instance.

Definition at line 776 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.set_script_name (   self,
  script_name 
)

Set script name.

Attribute 'scriptName' is owned by FormRepresentation, which is owned by Lemma.

Parameters
script_nameThe script name to set.
Returns
LexicalEntry instance.

Definition at line 453 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.set_semantic_domain (   self,
  semantic_domain,
  language = None 
)

Set semantic domain and language.

Attributes 'semanticDomain' and 'language' are owned by SubjectField, which is owned by Sense.

Parameters
semantic_domainThe semantic domain to set.
languageLanguage used to describe the semantic domain.
Returns
LexicalEntry instance.

Definition at line 1007 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.set_spelling_variant (   self,
  spelling_variant 
)

Set spelling variant.

Attribute 'spellingVariant' is owned by FormRepresentation, which is owned by Lemma.

Parameters
spelling_variantThe spelling variant to set.
Returns
LexicalEntry instance.

Definition at line 379 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.set_status (   self,
  status 
)

Set lexical entry status.

Parameters
statusThe status to set.
Returns
LexicalEntry instance.

Definition at line 100 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.set_tone (   self,
  tone 
)

Set tone.

Attribute 'tone' is owned by FormRepresentation, which is owned by Lemma.

Parameters
toneThe tone to set.
Returns
LexicalEntry instance.

Definition at line 305 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.set_translation (   self,
  translation,
  language = None 
)

Set translation and language.

Attributes 'translation' and 'language' are owned by Equivalent, which is owned by Sense.

Parameters
translationThe translation to set.
languageLanguage used for the translation.
Returns
LexicalEntry instance.

Definition at line 1037 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.set_transliteration (   self,
  transliteration 
)

Set transliteration.

Attribute 'transliteration' is owned by FormRepresentation, which is owned by Lemma.

Parameters
transliterationThe transliteration to set.
Returns
LexicalEntry instance.

Definition at line 433 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.set_usage_note (   self,
  usage_note,
  language = None 
)

Set usage note and language.

Attributes 'usageNote' and 'language' are owned by Statement, which owned by Definition, itself owned by Sense.

Parameters
usage_noteUsage note to set.
languageLanguage of the usage note.
Returns
LexicalEntry instance.

Definition at line 563 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.set_variant_comment (   self,
  comment,
  language = None 
)

Set variant comment and language.

Attributes 'comment' and 'language' are owned by FormRepresentation, which is owned by Lemma.

Parameters
commentVariant comment.
languageLanguage of comment.
Returns
LexicalEntry instance.

Definition at line 292 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.set_variant_form (   self,
  variant_form,
  type = "unspecified" 
)

Set variant form and type.

Attributes 'variantForm' and 'type' are owned by FormRepresentation, which is owned by Lemma.

Parameters
variant_formVariant form.
typeType of variant, in range 'type_variant_range' defined in 'common/range.py'.
Returns
LexicalEntry instance.

Definition at line 271 of file lexical_entry.py.

def pylmflib.pylmflib.core.lexical_entry.LexicalEntry.set_written_form (   self,
  written_form 
)

Set loan word.

Attribute 'writtenForm' is owned by Statement, which is owned by Definition, itself owned by Sense.

Parameters
written_formLoan word.
Returns
LexicalEntry instance.

Definition at line 637 of file lexical_entry.py.

Member Data Documentation

pylmflib.pylmflib.core.lexical_entry.LexicalEntry.bibliography

Definition at line 29 of file lexical_entry.py.

pylmflib.pylmflib.core.lexical_entry.LexicalEntry.date

Definition at line 26 of file lexical_entry.py.

pylmflib.pylmflib.core.lexical_entry.LexicalEntry.homonymNumber

Definition at line 24 of file lexical_entry.py.

pylmflib.pylmflib.core.lexical_entry.LexicalEntry.id

UID is managed at the Lexicon level.

Definition at line 31 of file lexical_entry.py.

pylmflib.pylmflib.core.lexical_entry.LexicalEntry.independentWord

Definition at line 28 of file lexical_entry.py.

pylmflib.pylmflib.core.lexical_entry.LexicalEntry.lemma

Lemma instance is owned by LexicalEntry There is one Lemma instance by LexicalEntry instance.

Definition at line 37 of file lexical_entry.py.

pylmflib.pylmflib.core.lexical_entry.LexicalEntry.list_of_components

ListOfComponents instance is owned by LexicalEntry There is zero or one ListOfComponents instance per LexicalEntry.

Definition at line 49 of file lexical_entry.py.

pylmflib.pylmflib.core.lexical_entry.LexicalEntry.partOfSpeech

Definition at line 27 of file lexical_entry.py.

pylmflib.pylmflib.core.lexical_entry.LexicalEntry.related_form

RelatedForm instances are owned by LexicalEntry There is zero to many RelatedForm instances per LexicalEntry.

Definition at line 40 of file lexical_entry.py.

pylmflib.pylmflib.core.lexical_entry.LexicalEntry.sense

Sense instances are owned by LexicalEntry There is zero to many Sense instances per LexicalEntry.

Definition at line 34 of file lexical_entry.py.

pylmflib.pylmflib.core.lexical_entry.LexicalEntry.status

Definition at line 25 of file lexical_entry.py.

pylmflib.pylmflib.core.lexical_entry.LexicalEntry.stem

Stem instances are owned by LexicalEntry There is zero to many Stem instances per LexicalEntry.

Definition at line 46 of file lexical_entry.py.

pylmflib.pylmflib.core.lexical_entry.LexicalEntry.targets

Definition at line 51 of file lexical_entry.py.

pylmflib.pylmflib.core.lexical_entry.LexicalEntry.word_form

WordForm instances are owned by LexicalEntry There is zero to many WordForm instances per LexicalEntry.

Definition at line 43 of file lexical_entry.py.


The documentation for this class was generated from the following file: