pylmflib.pylmflib.core.text_representation.TextRepresentation Class Reference

"Text Representation is a class representing the textual content of definition or statement. When there is more than one variant orthography, the Text Representation instance contains a Unicode string representing the textual content as well as unique attribute-value pairs that describe the specific language, script and orthography." (LMF) More...

Inheritance diagram for pylmflib.pylmflib.core.text_representation.TextRepresentation:

Public Member Functions
def	__init__
	Constructor. More...
def	__del__
	Destructor. More...
def	set_comment
	Set written form comment. More...
def	get_comment
	Get written form comment. More...
def	set_writtenForm
	Set written form and language. More...
def	get_writtenForm
	Get written form. More...
def	set_language
	Set language used for written form. More...
def	get_language
	Get language used for written form. More...
def	set_scriptName
	Set script name. More...
def	get_scriptName
	Get script name. More...

Public Attributes
	font
	comment
	writtenForm
	language
	scriptName

Detailed Description

"Text Representation is a class representing the textual content of definition or statement. When there is more than one variant orthography, the Text Representation instance contains a Unicode string representing the textual content as well as unique attribute-value pairs that describe the specific language, script and orthography." (LMF)

Definition at line 9 of file text_representation.py.

Constructor & Destructor Documentation

def pylmflib.pylmflib.core.text_representation.TextRepresentation.__init__

(

self

)

Constructor.

TextRepresentation instances are owned by Definition and Statement.

Returns

A TextRepresentation instance.

Definition at line 12 of file text_representation.py.

def pylmflib.pylmflib.core.text_representation.TextRepresentation.__del__

(

self

)

Destructor.

Definition at line 21 of file text_representation.py.

Member Function Documentation

def pylmflib.pylmflib.core.text_representation.TextRepresentation.get_comment

(

self

)

Get written form comment.

Returns

Representation attribute 'comment'.

Definition at line 36 of file text_representation.py.

def pylmflib.pylmflib.core.text_representation.TextRepresentation.get_language

(

self

)

Get language used for written form.

Returns

Representation attribute 'language'.

Definition at line 73 of file text_representation.py.

def pylmflib.pylmflib.core.text_representation.TextRepresentation.get_scriptName

(

self

)

Get script name.

Returns

Representation attribute 'scriptName'.

Definition at line 89 of file text_representation.py.

def pylmflib.pylmflib.core.text_representation.TextRepresentation.get_writtenForm	(		self,
			language = None
	)

Get written form.

Parameters

language

If this argument is given, get written form only if written in this language.

Returns

The filtered Representation attribute 'writtenForm'.

Definition at line 55 of file text_representation.py.

def pylmflib.pylmflib.core.text_representation.TextRepresentation.set_comment	(		self,
			comment
	)

Set written form comment.

Parameters

comment

Comment about the written form.

Returns

TextRepresentation instance.

Definition at line 26 of file text_representation.py.

def pylmflib.pylmflib.core.text_representation.TextRepresentation.set_language	(		self,
			language
	)

Set language used for written form.

Parameters

language

Language used for the written form.

Returns

TextRepresentation instance.

Definition at line 63 of file text_representation.py.

def pylmflib.pylmflib.core.text_representation.TextRepresentation.set_scriptName	(		self,
			script_name
	)

Set script name.

Parameters

script_name

The script name to set.

Returns

TextRepresentation instance.

Definition at line 79 of file text_representation.py.

def pylmflib.pylmflib.core.text_representation.TextRepresentation.set_writtenForm	(		self,
			written_form,
			language = None
	)

Set written form and language.

Parameters

written_form	The written form to set.
language	Language used for the written form.

Returns

TextRepresentation instance.

Definition at line 42 of file text_representation.py.

Member Data Documentation

pylmflib.pylmflib.core.text_representation.TextRepresentation.comment

Definition at line 33 of file text_representation.py.

pylmflib.pylmflib.core.text_representation.TextRepresentation.font

Definition at line 19 of file text_representation.py.

pylmflib.pylmflib.core.text_representation.TextRepresentation.language

Definition at line 70 of file text_representation.py.

pylmflib.pylmflib.core.text_representation.TextRepresentation.scriptName

Definition at line 86 of file text_representation.py.

pylmflib.pylmflib.core.text_representation.TextRepresentation.writtenForm

Definition at line 50 of file text_representation.py.

---

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

• /Users/celine/Work/CNRS/workspace/pylmflib/pylmflib/core/text_representation.py