Modules | Files | Inheritance Tree | Inheritance Graph | Name Index
module GNOME::Speech::Recognition
interface RuleName
Files: GNOME_Speech.idl
GNOME-Speech-Recognition-RuleName-inheritance GNOME-Speech-Recognition-Rule.html GNOME-Speech-SpeechObject.html Bonobo-Unknown.html
Operations Summary:
 voidinit(in string ruleName)
 voidinitFromComponents(in string packageName, in string simpleGrammarName, in string simpleRuleName) raises
 stringgetFullGrammarName()
 stringgetPackageName()
 stringgetRuleName()
 stringgetSimpleGrammarName()
 stringgetSimpleRuleName()
 booleanisLegalRuleName()
 booleanisLegalRuleNameFromName(in string name)
 booleanisRuleNamePart(in wchar c)
 voidsetRuleName(in string ruleName)
 voidsetRuleNameWithComponents(in string packageName, in string simpleGrammarName, in string simpleRuleName) raises

Operations Inherited from Rule
copy, toString

Operations Inherited from Bonobo::Unknown
ref, unref, queryInterface

Operation Details:
 void init(in string ruleName)

Initialize a RuleName from a string. Leading and trailing angle brackets are stripped if found. The rulename may be a simple rulename, qualified rulename or full-qualified rulename.

Parameters:
ruleName - the rule name.


 void initFromComponents(in string packageName, in string simpleGrammarName, in string simpleRuleName) raises (IllegalArgumentException)

Initialize a RuleName from its package-name, grammar-name and simple-name components. Leading and trailing angle brackets are stripped from ruleName if found. The package name may be null. The grammar name may be null only if packageName is null.

Parameters:
packageName - the package name of a fully-qualified rulename or null.
simpleGrammarName - the grammar name of a fully-qualified or qualified rule or null.
simpleRuleName - the simple rulename.


 string getFullGrammarName()

Get the full grammar name. If the packageName is null, the return value is the simple grammar name. May return null.

Return:
the full grammar name.


 string getPackageName()

Get the rule's package name.

Return:
the rule's package name.


 string getRuleName()

Get the rulename including the package and grammar name if they are non-null. The return value may be a fully-qualified rulename, qualified rulename, or simple rulename.

Return:
the rulename including the package and grammar name if they are non-null.


 string getSimpleGrammarName()

Get the simple grammar name. May be null.

Return:
the simple grammar name.


 string getSimpleRuleName()

Get the simple rulename.

Return:
the simple rulename.


 boolean isLegalRuleName()

Tests whether this RuleName is a legal grammar format rulename. The isLegalRuleNameFromRuleName method defines legal rulename forms.

Return:
a boolean indication of whether this RuleName is a legal grammar format rulename.
See Also:
isLegalRuleNameFromRuleName
isRuleNamePart


 boolean isLegalRuleNameFromName(in string name)

Tests whether a string is a legal grammar rulename format. The legal patterns for rulenames are defined above. The method does not test whether the rulename exists or is resolvable (see the resolve method of RuleGrammar).

An import string (e.g. "com.acme.*") is considered legal even though the "*" character is not a legal rulename character. If present, starting and ending angle brackets are ignored.

Parameters:
name - string to test.
Return:
an indication of whether @name is a legal grammar rulename format.
See Also:
isLegalRuleName
isRuleNamePart


 boolean isRuleNamePart(in wchar c)

Tests whether a character is a legal part of a Java Speech Grammar Format rulename.

Parameters:
c - character to test.
Return:
an indication of whether @c is a legal part of a Java Speech Grammar Format rulename.
See Also:
isLegalRuleName
isLegalRuleNameFromName


 void setRuleName(in string ruleName)

Set the rulename. The rulename may be a simple, qualified or fully-qualified rulename. Leading and trailing angle brackets are stripped if found.

Parameters:
ruleName - the rule name.


 void setRuleNameWithComponents(in string packageName, in string simpleGrammarName, in string simpleRuleName) raises (IllegalArgumentException)

Set the rule's name with package name, simple grammar name and simple rulename components. Leading and trailing angle brackets are stripped from ruleName. The package name may be null. The simple grammar name may be null only if packageName is null.

Parameters:
packageName - the package name of a fully-qualified rulename or null.
simpleGrammarName - the grammar name of a fully-qualified or qualified rule or null.
simpleRuleName - the simple rulename.