C# Класс Planetarium_Plugin.PlanetariumDB_API

Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод	Описание
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

Описание методов

addDictionary() публичный Метод

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
Результат	void

addKeyword() публичный Метод

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
Результат	void

dictionary_exists() публичный Метод

public dictionary_exists ( string type ) : bool
type	string
Результат	bool

getAllDictionaries() публичный Метод

function that returns all the dictionary in the database

public getAllDictionaries ( ) : List
Результат	List

getAllKeywordsInDictionary() публичный Метод

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
Результат	List

getAllStringKeywordsInDictionary() публичный Метод

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
Результат	List

getDictionary() публичный Метод

function that returns the dictionary specified

public getDictionary ( string type ) : Dictionary
type	string	the name of the dictionary to return
Результат	Dictionary

getKeyword() публичный Метод

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
Результат	Keyword

getKeyword() публичный Метод

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
Результат	string

keyword_exists() публичный Метод

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
Результат	bool

keyword_exists() публичный Метод

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
Результат	bool

removeDictionary() публичный Метод

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
Результат	void

removeKeyword() публичный Метод

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
Результат	void

updateDictionary() публичный Метод

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
Результат	void

updateDictionaryURL() публичный Метод

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
Результат	void

updateKeywordPhrase() публичный Метод

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
Результат	void