Package nltk_lite :: Package contrib :: Package toolbox :: Module settings :: Class MarkerSet
[hide private]
[frames] | no frames]

Class MarkerSet

source code

This class is a container for FieldMetadata objects. A marker set contains a list of the fields in a database together with information about those files.

The raw SFB looks like this:

   \+mkrset 
   \lngDefault Default
   \mkrRecord lx

   \+mkr dt
   \nam Date Last Edited
   \lng Default
   \mkrOverThis lx
   \-mkr

   \+mkr lx
   \nam Rotokas Word
   \lng Rotokas
   \-mkr
   \-mkrset
Instance Methods [hide private]
 
__init__(self) source code
list of strings
get_markers(self)
Obtain a list of all of the field markers for the marker set.
source code
 
add_field_metadata(self, fmeta)
Add FieldMetadata object to dictionary of marker sets, keyed by field marker.
source code
FieldMetadata
get_metadata_by_marker(self, mkr)
Obtain a FieldMetadata object for the field marker provided.
source code
 
get_field_marker_hierarchy(self) source code
 
build_tree(self, mkr, builder) source code
Method Details [hide private]

get_markers(self)

source code 

Obtain a list of all of the field markers for the marker set.

Returns: list of strings
list of field markers

add_field_metadata(self, fmeta)

source code 

Add FieldMetadata object to dictionary of marker sets, keyed by field marker.

Parameters:
  • fmeta (FieldMetadata) - field metadata to be added to collection for marker set

get_metadata_by_marker(self, mkr)

source code 

Obtain a FieldMetadata object for the field marker provided.

Parameters:
  • mkr (string) - field to obtain metadata for
Returns: FieldMetadata
metadata for field type associated with marker