C# Class Planetarium_Plugin.PlanetariumDB_API

Afficher le fichier Open project: coachlab/Planetarium-PowerPoint-Plugin Class Usage Examples

Méthodes publiques

Méthode	Description
addDictionary ( string type, string Slide_URL ) : void	function to add a dictionary to the database
addKeyword ( string dictionary, string phrase, int slide_num ) : void	function that adds a keyword to the specified dictionary
dictionary_exists ( string type ) : bool
getAllDictionaries ( ) : List	function that returns all the dictionary in the database
getAllKeywordsInDictionary ( string type ) : List	function that returns a list of all keywords for the given dictionary
getAllStringKeywordsInDictionary ( string type ) : List	function that return a list of string off all the keywords in the dictionary
getDictionary ( string type ) : Dictionary	function that returns the dictionary specified
getKeyword ( string type, string phrase ) : Keyword	Retrieves a keyword for a particular dictionary from the database
getKeyword ( string type, int slide_id ) : string	Retrieves a keyword for a particular dictionary from the database using its ID
keyword_exists ( string type, int slide_id ) : bool	Checks if a particular phrase is in a particular dictionary using the phrase ID
keyword_exists ( string type, string phrase ) : bool	Checks if a particular phrase is in a particular dictionary
removeDictionary ( string type ) : void	function to remove a dictionary from the database with related slide in the keyword dictionary
removeKeyword ( string phrase, string dictionary ) : void	function that removes a keyword from a dictionary
updateDictionary ( string type, string newType ) : void	function to update the dictionary given the name of the dictionary to update
updateDictionaryURL ( string type, string newSlide_URL ) : void	function to update the dictionary URL
updateKeywordPhrase ( string phrase, string newPhrase, string dictionary ) : void	function to update the phrase for a given keyword in a dictionary

Method Details

addDictionary() public méthode

function to add a dictionary to the database

public addDictionary ( string type, string Slide_URL ) : void
type	string	The name of the dictionary
Slide_URL	string	Where the Silde is store
Résultat	void

addKeyword() public méthode

function that adds a keyword to the specified dictionary

public addKeyword ( string dictionary, string phrase, int slide_num ) : void
dictionary	string	dictionary to add keyword to
phrase	string	the phrase to add to the dictionary specified
slide_num	int	the number of the slide
Résultat	void

dictionary_exists() public méthode

public dictionary_exists ( string type ) : bool
type	string
Résultat	bool

getAllDictionaries() public méthode

function that returns all the dictionary in the database

public getAllDictionaries ( ) : List
Résultat	List

getAllKeywordsInDictionary() public méthode

function that returns a list of all keywords for the given dictionary

public getAllKeywordsInDictionary ( string type ) : List
type	string	name of the dictionary to return keywords
Résultat	List

getAllStringKeywordsInDictionary() public méthode

function that return a list of string off all the keywords in the dictionary

public getAllStringKeywordsInDictionary ( string type ) : List
type	string	name of the dictionary to get keywords from
Résultat	List

getDictionary() public méthode

function that returns the dictionary specified

public getDictionary ( string type ) : Dictionary
type	string	the name of the dictionary to return
Résultat	Dictionary

getKeyword() public méthode

Retrieves a keyword for a particular dictionary from the database

public getKeyword ( string type, string phrase ) : Keyword
type	string	Dictionary name
phrase	string	Keyword ID
Résultat	Keyword

getKeyword() public méthode

Retrieves a keyword for a particular dictionary from the database using its ID

public getKeyword ( string type, int slide_id ) : string
type	string	Dictionary name
slide_id	int	Keyword ID
Résultat	string

keyword_exists() public méthode

Checks if a particular phrase is in a particular dictionary using the phrase ID

public keyword_exists ( string type, int slide_id ) : bool
type	string	Dictionary to look into
slide_id	int	ID of the slide
Résultat	bool

keyword_exists() public méthode

Checks if a particular phrase is in a particular dictionary

public keyword_exists ( string type, string phrase ) : bool
type	string	Dictionary to look into
phrase	string	phrase to look for
Résultat	bool

removeDictionary() public méthode

function to remove a dictionary from the database with related slide in the keyword dictionary

public removeDictionary ( string type ) : void
type	string	the name of the dictionary to remove
Résultat	void

removeKeyword() public méthode

function that removes a keyword from a dictionary

public removeKeyword ( string phrase, string dictionary ) : void
phrase	string	phrase to remove of the specified dictionary
dictionary	string	dictionary to remove it to
Résultat	void

updateDictionary() public méthode

function to update the dictionary given the name of the dictionary to update

public updateDictionary ( string type, string newType ) : void
type	string	name of dictionary to update
newType	string	new name to replace in the dictionary
Résultat	void

updateDictionaryURL() public méthode

function to update the dictionary URL

public updateDictionaryURL ( string type, string newSlide_URL ) : void
type	string	the name of the dictionary to update
newSlide_URL	string	new slide name to replace in for the dictionary
Résultat	void

updateKeywordPhrase() public méthode

function to update the phrase for a given keyword in a dictionary

public updateKeywordPhrase ( string phrase, string newPhrase, string dictionary ) : void
phrase	string	old phrase to update
newPhrase	string	new phrase to update to
dictionary	string	name of dictionary to update
Résultat	void