pylmflib.pylmflib.mrd.subject_field.SubjectField Class Reference

"Subject Field is a class representing a text string that provides domain or status information." (LMF) More...

Public Member Functions
def	__init__
	Constructor. More...
def	__del__
	Destructor. More...
def	set_semanticDomain
	Set semantic domain and language. More...
def	get_semanticDomain
	Get semantic domain. More...
def	set_language
	Set language used for semantic domain. More...
def	get_language
	Get language used for semantic domain. More...
def	create_and_add_subject_field
	Create and add a subject field. More...
def	get_subject_fields
	Get all subject fields maintained by this subject field. More...
def	set_sub_domain
	Set a sub-domain and language. More...
def	get_sub_domains
	Get all sub-domains. More...

Public Attributes
	language
	semanticDomain
	subject_field
	SubjectField instances are owned by SubjectField There is zero to many SubjectField instances per SubjectField. More...

Detailed Description

"Subject Field is a class representing a text string that provides domain or status information." (LMF)

Definition at line 8 of file subject_field.py.

Constructor & Destructor Documentation

def pylmflib.pylmflib.mrd.subject_field.SubjectField.__init__

(

self

)

Constructor.

SubjectField instances are owned by Sense.

Returns

A SubjectField instance.

Definition at line 11 of file subject_field.py.

def pylmflib.pylmflib.mrd.subject_field.SubjectField.__del__

(

self

)

Destructor.

Release SubjectField instances.

Definition at line 22 of file subject_field.py.

Member Function Documentation

def pylmflib.pylmflib.mrd.subject_field.SubjectField.create_and_add_subject_field

(

self

)

Create and add a subject field.

Returns

The created SubjectField instance.

Definition at line 67 of file subject_field.py.

def pylmflib.pylmflib.mrd.subject_field.SubjectField.get_language

(

self

)

Get language used for semantic domain.

Returns

SubjectField attribute 'language'.

Definition at line 61 of file subject_field.py.

def pylmflib.pylmflib.mrd.subject_field.SubjectField.get_semanticDomain	(		self,
			language = None
	)

Get semantic domain.

Parameters

language

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

Returns

The filtered SubjectField attribute 'semanticDomain'.

Definition at line 43 of file subject_field.py.

def pylmflib.pylmflib.mrd.subject_field.SubjectField.get_sub_domains	(		self,
			language = None
	)

Get all sub-domains.

Attribute 'semanticDomain' is owned by SubjectField, which is owned by SubjectField, etc.

Parameters

language

If this argument is given, get only semantic domains that are described using this language.

Returns

A Python list of all SubjectField attributes 'semanticDomain'.

Definition at line 90 of file subject_field.py.

def pylmflib.pylmflib.mrd.subject_field.SubjectField.get_subject_fields

(

self

)

Get all subject fields maintained by this subject field.

Returns

A Python list of subject fields.

Definition at line 75 of file subject_field.py.

def pylmflib.pylmflib.mrd.subject_field.SubjectField.set_language	(		self,
			language
	)

Set language used for semantic domain.

Parameters

language

Language used to describe the semantic domain.

Returns

SubjectField instance.

Definition at line 51 of file subject_field.py.

def pylmflib.pylmflib.mrd.subject_field.SubjectField.set_semanticDomain	(		self,
			semantic_domain,
			language = None
	)

Set semantic domain and language.

Parameters

semantic_domain	The semantic domain to set.
language	Language used to describe the semantic domain.

Returns

SubjectField instance.

Definition at line 30 of file subject_field.py.

def pylmflib.pylmflib.mrd.subject_field.SubjectField.set_sub_domain	(		self,
			semantic_domain,
			language = None
	)

Set a sub-domain and language.

Parameters

semantic_domain	The sub-domain to set.
language	Language used to describe the sub-domain.

Returns

SubjectField instance.

Definition at line 81 of file subject_field.py.

Member Data Documentation

pylmflib.pylmflib.mrd.subject_field.SubjectField.language

Definition at line 16 of file subject_field.py.

pylmflib.pylmflib.mrd.subject_field.SubjectField.semanticDomain

Definition at line 17 of file subject_field.py.

pylmflib.pylmflib.mrd.subject_field.SubjectField.subject_field

SubjectField instances are owned by SubjectField There is zero to many SubjectField instances per SubjectField.

Definition at line 20 of file subject_field.py.

---

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

• /Users/celine/Work/CNRS/workspace/pylmflib/pylmflib/mrd/subject_field.py