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

"Statement is a class representating a narrative description that refines or complements Definition." (LMF) More...

Public Member Functions

def __init__
 Constructor. More...
 
def __del__
 Destructor. More...
 
def set_note
 Set note. More...
 
def get_note
 Get note. More...
 
def set_language
 Set language used for the note. More...
 
def get_language
 Get language used for the note. More...
 
def set_noteType
 Set type of the note. More...
 
def get_noteType
 Get type of the note. More...
 
def set_usageNote
 Set usage note. More...
 
def get_usageNote
 Get usage note. More...
 
def set_encyclopedicInformation
 Set encyclopedic information. More...
 
def get_encyclopedicInformation
 Get encyclopedic information. More...
 
def set_restriction
 Set restriction. More...
 
def get_restriction
 Get restriction. More...
 
def set_borrowedWord
 
def get_borrowedWord
 
def set_writtenForm
 
def get_writtenForm
 
def set_etymology
 
def get_etymology
 
def set_etymologyComment
 
def get_etymologyComment
 
def set_termSourceLanguage
 
def get_termSourceLanguage
 
def set_etymologyGloss
 
def get_etymologyGloss
 
def set_etymologySource
 
def get_etymologySource
 
def set_scientificName
 
def get_scientificName
 

Public Attributes

 noteType
 
 note
 
 language
 
 encyclopedicInformation
 
 usageNote
 
 restriction
 
 derivation
 
 borrowedWord
 
 writtenForm
 
 sense
 
 etymology
 
 etymologyComment
 
 etymologyGloss
 
 etymologySource
 
 termSourceLanguage
 
 targetLexicalEntry
 
 scientificName
 
 text_representation
 TextRepresentation instances are owned by Statement There is zero to many TextRepresentation instances per Statement. More...
 

Detailed Description

"Statement is a class representating a narrative description that refines or complements Definition." (LMF)

Definition at line 9 of file statement.py.

Constructor & Destructor Documentation

def pylmflib.pylmflib.core.statement.Statement.__init__ (   self)

Constructor.

Statement instances are owned by Definition.

Returns
A Statement instance.

Definition at line 12 of file statement.py.

def pylmflib.pylmflib.core.statement.Statement.__del__ (   self)

Destructor.

Release TextRepresentation instances.

Definition at line 38 of file statement.py.

Member Function Documentation

def pylmflib.pylmflib.core.statement.Statement.get_borrowedWord (   self)
Get source language (in English).
@return Statement attribute 'borrowedWord'.

Definition at line 179 of file statement.py.

def pylmflib.pylmflib.core.statement.Statement.get_encyclopedicInformation (   self,
  language = None 
)

Get encyclopedic information.

Parameters
languageIf this argument is given, get encyclopedic information only if written in this language.
Returns
The filtered Statement attribute 'encyclopedicInformation'.

Definition at line 138 of file statement.py.

def pylmflib.pylmflib.core.statement.Statement.get_etymology (   self)
Get etymology.
@return Statement attribute 'etymology'.

Definition at line 211 of file statement.py.

def pylmflib.pylmflib.core.statement.Statement.get_etymologyComment (   self,
  term_source_language = None 
)
Get etymology comment (in English).
@param term_source_language The language of the etymology comment to retrieve.
@return Statement attribute 'etymologyComment'.

Definition at line 230 of file statement.py.

def pylmflib.pylmflib.core.statement.Statement.get_etymologyGloss (   self)
Get etymology gloss.
@return Statement attribute 'etymologyGloss'.

Definition at line 264 of file statement.py.

def pylmflib.pylmflib.core.statement.Statement.get_etymologySource (   self)
Get etymology source.
@return Statement attribute 'etymologySource'.

Definition at line 280 of file statement.py.

def pylmflib.pylmflib.core.statement.Statement.get_language (   self)

Get language used for the note.

Returns
Statement attribute 'language'.

Definition at line 83 of file statement.py.

def pylmflib.pylmflib.core.statement.Statement.get_note (   self,
  type = None,
  language = None 
)

Get note.

Parameters
typeIf this argument is given, get note only if its type corresponds.
languageIf this argument is given, get note only if written in this language.
Returns
The filtered Statement attribute 'note'.

Definition at line 60 of file statement.py.

def pylmflib.pylmflib.core.statement.Statement.get_noteType (   self)

Get type of the note.

Returns
Statement attribute 'noteType'.

Definition at line 100 of file statement.py.

def pylmflib.pylmflib.core.statement.Statement.get_restriction (   self,
  language = None 
)

Get restriction.

Parameters
languageIf this argument is given, get restriction only if written in this language.
Returns
The filtered Statement attribute 'restriction'.

Definition at line 159 of file statement.py.

def pylmflib.pylmflib.core.statement.Statement.get_scientificName (   self)
Get scientific name.
@return Statement attribute 'scientificName'.

Definition at line 296 of file statement.py.

def pylmflib.pylmflib.core.statement.Statement.get_termSourceLanguage (   self)
Get language used for the etymology comment.
@return Statement attribute 'termSourceLanguage'.

Definition at line 248 of file statement.py.

def pylmflib.pylmflib.core.statement.Statement.get_usageNote (   self,
  language = None 
)

Get usage note.

Parameters
languageIf this argument is given, get usage note only if written in this language.
Returns
The filtered Statement attribute 'usageNote'.

Definition at line 117 of file statement.py.

def pylmflib.pylmflib.core.statement.Statement.get_writtenForm (   self)
Get loan word.
@return Statement attribute 'writtenForm'.

Definition at line 195 of file statement.py.

def pylmflib.pylmflib.core.statement.Statement.set_borrowedWord (   self,
  borrowed_word 
)
Set source language (in English), e.g. "Chinese".
@param borrowed_word The source language to set.
@return Statement instance.

Definition at line 169 of file statement.py.

def pylmflib.pylmflib.core.statement.Statement.set_encyclopedicInformation (   self,
  encyclopedic_information,
  language = None 
)

Set encyclopedic information.

Parameters
encyclopedic_informationEncyclopedic information to set.
languageLanguage used for the encyclopedic information.
Returns
Statement instance.

Definition at line 127 of file statement.py.

def pylmflib.pylmflib.core.statement.Statement.set_etymology (   self,
  etymology 
)
Set etymology.
@param etymolgy The etymology to set.
@return Statement instance.

Definition at line 201 of file statement.py.

def pylmflib.pylmflib.core.statement.Statement.set_etymologyComment (   self,
  etymology_comment,
  term_source_language = None 
)
Set etymology comment (in English).
@param etymolgy_comment The etymology comment to set.
@param term_source_language The language used for the comment.
@return Statement instance.

Definition at line 217 of file statement.py.

def pylmflib.pylmflib.core.statement.Statement.set_etymologyGloss (   self,
  etymology_gloss 
)
Set etymology gloss.
@param etymolgy_gloss The etymology gloss to set.
@return Statement instance.

Definition at line 254 of file statement.py.

def pylmflib.pylmflib.core.statement.Statement.set_etymologySource (   self,
  etymology_source 
)
Set etymology source.
@param etymolgy_source The etymology source to set.
@return Statement instance.

Definition at line 270 of file statement.py.

def pylmflib.pylmflib.core.statement.Statement.set_language (   self,
  language 
)

Set language used for the note.

Parameters
languageLanguage used for the note.
Returns
Statement instance.

Definition at line 73 of file statement.py.

def pylmflib.pylmflib.core.statement.Statement.set_note (   self,
  note,
  type = None,
  language = None 
)

Set note.

Parameters
noteNote to set.
typeType of the note.
languageLanguage used for the note.
Returns
Statement instance.

Definition at line 46 of file statement.py.

def pylmflib.pylmflib.core.statement.Statement.set_noteType (   self,
  note_type 
)

Set type of the note.

Parameters
note_typeType of the note.
Returns
Statement instance.

Definition at line 89 of file statement.py.

def pylmflib.pylmflib.core.statement.Statement.set_restriction (   self,
  restriction,
  language = None 
)

Set restriction.

Parameters
restrictionRestriction to set.
languageLanguage used for the restriction.
Returns
Statement instance.

Definition at line 148 of file statement.py.

def pylmflib.pylmflib.core.statement.Statement.set_scientificName (   self,
  scientific_name 
)
Set scientific name.
@param scientific_name The scientific name to set.
@return Statement instance.

Definition at line 286 of file statement.py.

def pylmflib.pylmflib.core.statement.Statement.set_termSourceLanguage (   self,
  term_source_language 
)
Set language used for the etymology comment.
@param term_source_language The etymology comment language to set.
@return Statement instance.

Definition at line 238 of file statement.py.

def pylmflib.pylmflib.core.statement.Statement.set_usageNote (   self,
  usage_note,
  language = None 
)

Set usage note.

Parameters
usage_noteUsage note to set.
languageLanguage used for the usage note.
Returns
Statement instance.

Definition at line 106 of file statement.py.

def pylmflib.pylmflib.core.statement.Statement.set_writtenForm (   self,
  written_form 
)
Set loan word.
@param written_form The loan word to set.
@return Statement instance.

Definition at line 185 of file statement.py.

Member Data Documentation

pylmflib.pylmflib.core.statement.Statement.borrowedWord

Definition at line 24 of file statement.py.

pylmflib.pylmflib.core.statement.Statement.derivation

Definition at line 23 of file statement.py.

pylmflib.pylmflib.core.statement.Statement.encyclopedicInformation

Definition at line 20 of file statement.py.

pylmflib.pylmflib.core.statement.Statement.etymology

Definition at line 27 of file statement.py.

pylmflib.pylmflib.core.statement.Statement.etymologyComment

Definition at line 28 of file statement.py.

pylmflib.pylmflib.core.statement.Statement.etymologyGloss

Definition at line 29 of file statement.py.

pylmflib.pylmflib.core.statement.Statement.etymologySource

Definition at line 30 of file statement.py.

pylmflib.pylmflib.core.statement.Statement.language

Definition at line 19 of file statement.py.

pylmflib.pylmflib.core.statement.Statement.note

Definition at line 18 of file statement.py.

pylmflib.pylmflib.core.statement.Statement.noteType

Definition at line 17 of file statement.py.

pylmflib.pylmflib.core.statement.Statement.restriction

Definition at line 22 of file statement.py.

pylmflib.pylmflib.core.statement.Statement.scientificName

Definition at line 33 of file statement.py.

pylmflib.pylmflib.core.statement.Statement.sense

Definition at line 26 of file statement.py.

pylmflib.pylmflib.core.statement.Statement.targetLexicalEntry

Definition at line 32 of file statement.py.

pylmflib.pylmflib.core.statement.Statement.termSourceLanguage

Definition at line 31 of file statement.py.

pylmflib.pylmflib.core.statement.Statement.text_representation

TextRepresentation instances are owned by Statement There is zero to many TextRepresentation instances per Statement.

Definition at line 36 of file statement.py.

pylmflib.pylmflib.core.statement.Statement.usageNote

Definition at line 21 of file statement.py.

pylmflib.pylmflib.core.statement.Statement.writtenForm

Definition at line 25 of file statement.py.


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