Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members

word Class Reference

Class word stores all info related to a word: form, list of analysis, list of tokens (if multiword). More...

#include <language.h>

Inheritance diagram for word:

Inheritance graph
[legend]
Collaboration diagram for word:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 word ()
 constructor
 word (const string &)
 constructor
 word (const string &, const list< word > &)
 constructor
 word (const string &, const list< analysis > &, const list< word > &)
 constructor
 word (const word &)
 Copy constructor.
wordoperator= (const word &)
 assignment
bool is_ambiguous (void) const
 true iff the word has more than one analysis
bool is_multiword (void) const
 true iff the word is a multiword compound
int get_n_words_mw (void) const
 get number of words in compound
list< wordget_words_mw (void) const
 get word objects that compound the multiword
string get_form (void) const
 get word form
analysis get_selected_analysis (void) const
 Get the selected analysis.
word::iterator selected_analysis (void) const
 Get an iterator to the selected analysis.
string get_lemma (void) const
 get lemma for the selected analysis in list
string get_parole (void) const
 get parole for the selected analysis
string get_short_parole (const string &) const
 get parole (short version) for the selected analysis
list< string > get_senses (void) const
 get sense list for the selected analysis
void set_senses (const list< string > &)
 set sense list for the selected analysis
unsigned int get_span_start (void) const
 get token span.
unsigned int get_span_finish (void) const
bool found_in_dict (void) const
 get in_dict
void set_found_in_dict (bool)
 set in_dict
void add_analysis (const analysis &)
 add one analysis to current analysis list (no duplicate check!)
void set_analysis (const analysis &)
 set analysis list to one single analysis, overwriting current values
void set_analysis (const list< analysis > &)
 set analysis list, overwriting current values
void set_form (const string &)
 set word form
void set_span (unsigned int, unsigned int)
 set token span
void set_user_data (void *)
 set user data
int get_n_analysis (void) const
 get number of analysis in current list
void copy_analysis (const word &)
 copy analysis list
void select_analysis (word::iterator)
 mark the given analysis as the selected one.
list< analysisget_analysis (void) const
 get list of analysis (useful for perl API)
word::iterator analysis_begin (void)
 get begin iterator to analysis list (useful for perl/java API)
word::const_iterator analysis_begin (void) const
word::iterator analysis_end (void)
 get end iterator to analysis list (useful for perl/java API)
word::const_iterator analysis_end (void) const

Private Attributes

string form
 lexical form
word::iterator selected
 selected analysis (if any)
list< wordmultiword
 empty list if not a multiword
unsigned int start
 token span
unsigned int finish
bool in_dict
 word form found in dictionary
void * user
 Private data.

Detailed Description

Class word stores all info related to a word: form, list of analysis, list of tokens (if multiword).


Constructor & Destructor Documentation

word::word  ) 
 

constructor

word::word const string &   ) 
 

constructor

word::word const string &  ,
const list< word > & 
 

constructor

word::word const string &  ,
const list< analysis > &  ,
const list< word > & 
 

constructor

word::word const word  ) 
 

Copy constructor.


Member Function Documentation

void word::add_analysis const analysis  ) 
 

add one analysis to current analysis list (no duplicate check!)

word::const_iterator word::analysis_begin void   )  const
 

word::iterator word::analysis_begin void   ) 
 

get begin iterator to analysis list (useful for perl/java API)

word::const_iterator word::analysis_end void   )  const
 

word::iterator word::analysis_end void   ) 
 

get end iterator to analysis list (useful for perl/java API)

void word::copy_analysis const word  ) 
 

copy analysis list

bool word::found_in_dict void   )  const
 

get in_dict

list< analysis > word::get_analysis void   )  const
 

get list of analysis (useful for perl API)

string word::get_form void   )  const
 

get word form

string word::get_lemma void   )  const
 

get lemma for the selected analysis in list

int word::get_n_analysis void   )  const
 

get number of analysis in current list

int word::get_n_words_mw void   )  const
 

get number of words in compound

string word::get_parole void   )  const
 

get parole for the selected analysis

analysis word::get_selected_analysis void   )  const
 

Get the selected analysis.

list< string > word::get_senses void   )  const
 

get sense list for the selected analysis

string word::get_short_parole const string &   )  const
 

get parole (short version) for the selected analysis

unsigned int word::get_span_finish void   )  const
 

unsigned int word::get_span_start void   )  const
 

get token span.

list< word > word::get_words_mw void   )  const
 

get word objects that compound the multiword

bool word::is_ambiguous void   )  const
 

true iff the word has more than one analysis

bool word::is_multiword void   )  const
 

true iff the word is a multiword compound

word & word::operator= const word  ) 
 

assignment

void word::select_analysis word::iterator   ) 
 

mark the given analysis as the selected one.

word::iterator word::selected_analysis void   )  const
 

Get an iterator to the selected analysis.

void word::set_analysis const list< analysis > &   ) 
 

set analysis list, overwriting current values

void word::set_analysis const analysis  ) 
 

set analysis list to one single analysis, overwriting current values

void word::set_form const string &   ) 
 

set word form

void word::set_found_in_dict bool   ) 
 

set in_dict

void word::set_senses const list< string > &   ) 
 

set sense list for the selected analysis

void word::set_span unsigned  int,
unsigned  int
 

set token span

void word::set_user_data void *   ) 
 

set user data


Member Data Documentation

unsigned int word::finish [private]
 

string word::form [private]
 

lexical form

bool word::in_dict [private]
 

word form found in dictionary

list<word> word::multiword [private]
 

empty list if not a multiword

word::iterator word::selected [private]
 

selected analysis (if any)

unsigned int word::start [private]
 

token span

void* word::user [private]
 

Private data.


The documentation for this class was generated from the following files:
Generated on Wed Apr 26 12:59:23 2006 for FreeLing by  doxygen 1.4.4