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

"Lexical Resource is a class representing the entire resource and is a container for one or more lexicons. There is only one Lexical Resource instance." (LMF) More...

Public Member Functions

def __init__
 Constructor. More...
 
def __del__
 Destructor. More...
 
def get_lexicons
 Get all lexicons maintained by the lexical resource. More...
 
def add_lexicon
 Add a lexicon to the lexical resource. More...
 
def remove_lexicon
 Remove a lexicon from the lexical resource. More...
 
def get_lexicon
 
def set_dtdVersion
 Set DTD version. More...
 
def get_dtdVersion
 Get DTD version. More...
 
def set_language_code
 Set language code. More...
 
def get_language_code
 Get language code. More...
 
def set_version
 Set version. More...
 
def get_version
 Get version. More...
 
def set_license
 Set license. More...
 
def get_license
 Get license. More...
 
def set_character_encoding
 Set character encoding. More...
 
def get_character_encoding
 Get character encoding. More...
 
def set_date_coding
 Set date coding. More...
 
def get_date_coding
 Get date coding. More...
 
def set_project_name
 Set project name. More...
 
def get_project_name
 Get project name. More...
 
def set_creation_date
 Set creation date. More...
 
def get_creation_date
 Get creation date. More...
 
def set_last_update
 Set last update. More...
 
def get_last_update
 Get last update. More...
 
def set_author
 Set author. More...
 
def get_author
 Get author. More...
 
def set_description
 Set description. More...
 
def get_description
 Get description. More...
 
def get_bibliographic_citation
 Get bibliographic citation. More...
 

Public Attributes

 dtdVersion
 
 global_information
 GlobalInformation instance is owned by LexicalResource There is one GlobalInformation for one LexicalResource. More...
 
 lexicon
 Lexicon instances are owned by LexicalResource There is one or more Lexicon instances for one unique LexicalResource. More...
 
 speaker
 Speaker instances are owned by LexicalResource There is zero to many Speaker instances for one unique LexicalResource. More...
 

Detailed Description

"Lexical Resource is a class representing the entire resource and is a container for one or more lexicons. There is only one Lexical Resource instance." (LMF)

Definition at line 8 of file lexical_resource.py.

Constructor & Destructor Documentation

def pylmflib.pylmflib.core.lexical_resource.LexicalResource.__init__ (   self,
  dtd_version = 16 
)

Constructor.

Returns
A LexicalResource instance.

Definition at line 11 of file lexical_resource.py.

def pylmflib.pylmflib.core.lexical_resource.LexicalResource.__del__ (   self)

Destructor.

Release GlobalInformation, Lexicon, Speaker instances.

Definition at line 26 of file lexical_resource.py.

Member Function Documentation

def pylmflib.pylmflib.core.lexical_resource.LexicalResource.add_lexicon (   self,
  lexicon 
)

Add a lexicon to the lexical resource.

Parameters
lexiconA Lexicon instance to add to the Lexical Resource.
Returns
Lexical Resource instance.

Definition at line 45 of file lexical_resource.py.

def pylmflib.pylmflib.core.lexical_resource.LexicalResource.get_author (   self)

Get author.

Attribute 'author' is owned by GlobalInformation.

Returns
GlobalInformation attribute 'author'.

Definition at line 221 of file lexical_resource.py.

def pylmflib.pylmflib.core.lexical_resource.LexicalResource.get_bibliographic_citation (   self)

Get bibliographic citation.

Attribute 'bibliographicCitation' is owned by GlobalInformation.

Returns
GlobalInformation attribute 'bibliographicCitation'.

Definition at line 244 of file lexical_resource.py.

def pylmflib.pylmflib.core.lexical_resource.LexicalResource.get_character_encoding (   self)

Get character encoding.

Attribute 'characterEncoding' is owned by GlobalInformation.

Returns
GlobalInformation attribute 'characterEncoding'.

Definition at line 141 of file lexical_resource.py.

def pylmflib.pylmflib.core.lexical_resource.LexicalResource.get_creation_date (   self)

Get creation date.

Attribute 'creationDate' is owned by GlobalInformation.

Returns
GlobalInformation attribute 'creationdDate'.

Definition at line 189 of file lexical_resource.py.

def pylmflib.pylmflib.core.lexical_resource.LexicalResource.get_date_coding (   self)

Get date coding.

Attribute 'dateCoding' is owned by GlobalInformation.

Returns
GlobalInformation attribute 'dateCoding'.

Definition at line 157 of file lexical_resource.py.

def pylmflib.pylmflib.core.lexical_resource.LexicalResource.get_description (   self)

Get description.

Attribute 'description' is owned by GlobalInformation.

Returns
GlobalInformation attribute 'description'.

Definition at line 237 of file lexical_resource.py.

def pylmflib.pylmflib.core.lexical_resource.LexicalResource.get_dtdVersion (   self)

Get DTD version.

Returns
LexicalResource attribute 'dtdVersion'.

Definition at line 78 of file lexical_resource.py.

def pylmflib.pylmflib.core.lexical_resource.LexicalResource.get_language_code (   self)

Get language code.

Attribute 'languageCode' is owned by GlobalInformation.

Returns
GlobalInformation attribute 'languageCode'.

Definition at line 93 of file lexical_resource.py.

def pylmflib.pylmflib.core.lexical_resource.LexicalResource.get_last_update (   self)

Get last update.

Attribute 'lastUpdate' is owned by GlobalInformation.

Returns
GlobalInformation attribute 'lastUpdate'.

Definition at line 205 of file lexical_resource.py.

def pylmflib.pylmflib.core.lexical_resource.LexicalResource.get_lexicon (   self,
  id 
)
Retrieve a lexicon from its identifier.
@param id The identifier of the lexicon to retrieve.
@result A Lexicon instance, or None if not found.

Definition at line 61 of file lexical_resource.py.

def pylmflib.pylmflib.core.lexical_resource.LexicalResource.get_lexicons (   self)

Get all lexicons maintained by the lexical resource.

Returns
A Python list of lexicons.

Definition at line 39 of file lexical_resource.py.

def pylmflib.pylmflib.core.lexical_resource.LexicalResource.get_license (   self)

Get license.

Attribute 'license' is owned by GlobalInformation.

Returns
GlobalInformation attribute 'license'.

Definition at line 125 of file lexical_resource.py.

def pylmflib.pylmflib.core.lexical_resource.LexicalResource.get_project_name (   self)

Get project name.

Attribute 'projectName' is owned by GlobalInformation.

Returns
GlobalInformation attribute 'projectName'.

Definition at line 173 of file lexical_resource.py.

def pylmflib.pylmflib.core.lexical_resource.LexicalResource.get_version (   self)

Get version.

Attribute 'version' is owned by GlobalInformation.

Returns
GlobalInformation attribute 'version'.

Definition at line 109 of file lexical_resource.py.

def pylmflib.pylmflib.core.lexical_resource.LexicalResource.remove_lexicon (   self,
  lexicon 
)

Remove a lexicon from the lexical resource.

Parameters
lexiconThe Lexicon instance to remove from the Lexical Resource.
Returns
Lexical Resource instance.

Definition at line 53 of file lexical_resource.py.

def pylmflib.pylmflib.core.lexical_resource.LexicalResource.set_author (   self,
  author 
)

Set author.

Attribute 'author' is owned by GlobalInformation.

Parameters
authorThe author's name to set.
Returns
LexicalResource instance.

Definition at line 212 of file lexical_resource.py.

def pylmflib.pylmflib.core.lexical_resource.LexicalResource.set_character_encoding (   self,
  character_encoding 
)

Set character encoding.

Attribute 'characterEncoding' is owned by GlobalInformation.

Parameters
character_encodingThe character encoding to use.
Returns
LexicalResource instance.

Definition at line 132 of file lexical_resource.py.

def pylmflib.pylmflib.core.lexical_resource.LexicalResource.set_creation_date (   self,
  date 
)

Set creation date.

Attribute 'creationDate' is owned by GlobalInformation.

Parameters
dateThe date to set, in format YYYY-MM-DD.
Returns
LexicalResource instance.

Definition at line 180 of file lexical_resource.py.

def pylmflib.pylmflib.core.lexical_resource.LexicalResource.set_date_coding (   self,
  date_coding 
)

Set date coding.

Attribute 'dateCoding' is owned by GlobalInformation.

Parameters
date_codingThe date coding to use.
Returns
LexicalResource instance.

Definition at line 148 of file lexical_resource.py.

def pylmflib.pylmflib.core.lexical_resource.LexicalResource.set_description (   self,
  description 
)

Set description.

Attribute 'description' is owned by GlobalInformation.

Parameters
descriptionThe description to set.
Returns
LexicalResource instance.

Definition at line 228 of file lexical_resource.py.

def pylmflib.pylmflib.core.lexical_resource.LexicalResource.set_dtdVersion (   self,
  dtd_version 
)

Set DTD version.

Parameters
dtd_versionThe DTD version to use.
Returns
LexicalResource instance.

Definition at line 70 of file lexical_resource.py.

def pylmflib.pylmflib.core.lexical_resource.LexicalResource.set_language_code (   self,
  language_code 
)

Set language code.

Attribute 'languageCode' is owned by GlobalInformation.

Parameters
language_codeThe language code to use.
Returns
LexicalResource instance.

Definition at line 84 of file lexical_resource.py.

def pylmflib.pylmflib.core.lexical_resource.LexicalResource.set_last_update (   self,
  date 
)

Set last update.

Attribute 'lastUpdate' is owned by GlobalInformation.

Parameters
dateThe date to set, in format YYYY-MM-DD.
Returns
LexicalResource instance.

Definition at line 196 of file lexical_resource.py.

def pylmflib.pylmflib.core.lexical_resource.LexicalResource.set_license (   self,
  license 
)

Set license.

Attribute 'license' is owned by GlobalInformation.

Parameters
licenseThe license to set.
Returns
LexicalResource instance.

Definition at line 116 of file lexical_resource.py.

def pylmflib.pylmflib.core.lexical_resource.LexicalResource.set_project_name (   self,
  project_name 
)

Set project name.

Attribute 'projectName' is owned by GlobalInformation.

Parameters
project_nameThe project's name to set.
Returns
LexicalResource instance.

Definition at line 164 of file lexical_resource.py.

def pylmflib.pylmflib.core.lexical_resource.LexicalResource.set_version (   self,
  version 
)

Set version.

Attribute 'version' is owned by GlobalInformation.

Parameters
versionThe version to set.
Returns
LexicalResource instance.

Definition at line 100 of file lexical_resource.py.

Member Data Documentation

pylmflib.pylmflib.core.lexical_resource.LexicalResource.dtdVersion

Definition at line 15 of file lexical_resource.py.

pylmflib.pylmflib.core.lexical_resource.LexicalResource.global_information

GlobalInformation instance is owned by LexicalResource There is one GlobalInformation for one LexicalResource.

Definition at line 18 of file lexical_resource.py.

pylmflib.pylmflib.core.lexical_resource.LexicalResource.lexicon

Lexicon instances are owned by LexicalResource There is one or more Lexicon instances for one unique LexicalResource.

Definition at line 21 of file lexical_resource.py.

pylmflib.pylmflib.core.lexical_resource.LexicalResource.speaker

Speaker instances are owned by LexicalResource There is zero to many Speaker instances for one unique LexicalResource.

Definition at line 24 of file lexical_resource.py.


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