All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class COM.Lexical.Metaphrase.RMIMetaphrase

java.lang.Object
    |
    +----COM.Lexical.Metaphrase.Metaphrase
            |
            +----COM.Lexical.Metaphrase.RMIMetaphrase

public class RMIMetaphrase

extends Metaphrase

Version:

Authority1.1, 11 Apr 2000

RMIMetaphrase()

Creates a new RMIMetaphrase instance with the default database.

RMIMetaphrase(String)

Creates a new RMIMetaphrase instance with the given database.

RMIMetaphrase(String, String)

Creates a new RMIMetaphrase instance.

RMIMetaphrase(String, String, String, String)

Creates a new RMIMetaphrase instance.

flush()

Flush the cache.

getConcepts(Source)

Returns Concept's with one or more Atom's from source [or a subsource of source].

getDBNames()

Get list of DBNames on default server.

getDBNames(String)

Get list of DBNames on named server.

matches(String, int)

Returns Match'es to given String against database.

matches(String, SearchSpec)

Returns MatchSet's to given String against database.

serverSoftwareVersion()

Identify the version of server software on the default server.

serverSoftwareVersion(String)

Identify the version of server software on the named server.

submitTerm(String, Source, Concept, String, Concept[], Dictionary)

Submit a new term for review and possible addition to the given source.

public RMIMetaphrase() throws MetaphraseException

          Creates a new RMIMetaphrase instance with the default database.

Throws:

MetaphraseException - thrown in case of an error accessing the RemoteMetaphrase.

public RMIMetaphrase(java.lang.String DBName) throws MetaphraseException

          Creates a new RMIMetaphrase instance with the given database.

Parameters:

DBName - the database name.

Throws:

MetaphraseException - thrown in case of an error accessing the RemoteMetaphrase.

public RMIMetaphrase(java.lang.String serverURL,
                     java.lang.String DBName) throws MetaphraseException

          Creates a new RMIMetaphrase instance.

Parameters:

URL - the URL for the RemoteMetaphrase object.

DBName - the database name.

Throws:

MetaphraseException - thrown in case of an error accessing the RemoteMetaphrase.

public RMIMetaphrase(java.lang.String serverURL,
                     java.lang.String DBName,
                     java.lang.String username,
                     java.lang.String password) throws MetaphraseException

          Creates a new RMIMetaphrase instance.

Parameters:

URL - the URL for the RemoteMetaphrase object.

DBName - the database name.

username - a username on server.

password - user's password on server.

Throws:

MetaphraseException - thrown in case of an error accessing the RemoteMetaphrase.

public void flush() throws MetaphraseException

          Flush the cache. The application is responsible for releasing all references to Metaphrase data objects before or after calling this method.

Throws:

MetaphraseException - thrown in case of a failure to reinitialize the cache. If this happens, do not continue to use this Metaphrase unless and until flush can be called successfully--it won't work.

Overrides:

flush in class Metaphrase

public static java.lang.String[] getDBNames() throws MetaphraseException

          Get list of DBNames on default server.

Throws:

MetaphraseException - thrown in case of an error accessing the RemoteMetaphrase.

public static java.lang.String[] getDBNames(java.lang.String serverURL) throws MetaphraseException

          Get list of DBNames on named server.

Parameters:

URL - the URL for the RemoteMetaphrase object.

Throws:

MetaphraseException - thrown in case of an error accessing the RemoteMetaphrase.

public java.lang.String serverSoftwareVersion() throws MetaphraseException

          Identify the version of server software on the default server.

Throws:

MetaphraseException - thrown in case of an error accessing the RemoteMetaphrase.

Overrides:

serverSoftwareVersion in class Metaphrase

public static java.lang.String serverSoftwareVersion(java.lang.String serverURL) throws MetaphraseException

          Identify the version of server software on the named server.

Parameters:

serverURL - the URL of the server.

Throws:

MetaphraseException - thrown in case of an error accessing the RemoteMetaphrase.

public java.util.Enumeration matches(java.lang.String input,
                           int limit) throws MetaphraseException

          Returns Match'es to given String against database.

Parameters:

input - String to match against.

limit - upper bound on number of matches returned.

Throws:

MetaphraseException - thrown in case of an error accessing Metaphrase.

Overrides:

matches in class Metaphrase

See Also:

matches(java.lang.String, COM.Lexical.Metaphrase.SearchSpec)

public java.util.Enumeration matches(java.lang.String input,
                           SearchSpec spec) throws MetaphraseException

          Returns MatchSet's to given String against database. Depending on the value of spec, the return may or may not contain only Match'es (singleton MatchSet's).

Parameters:

input - String to match against.

spec - a SearchSpec.

Throws:

MetaphraseException - thrown in case of an error accessing Metaphrase.

Overrides:

matches in class Metaphrase

public java.util.Enumeration getConcepts(Source source) throws MetaphraseException

          Returns Concept's with one or more Atom's from source [or a subsource of source].

Throws:

MetaphraseException - thrown in case of an error accessing Metaphrase.

Overrides:

getConcepts in class Metaphrase

public java.lang.String submitTerm(java.lang.String name,
                         Source source,
                         Concept nearestConcept,
                         java.lang.String note,
                         Concept relatedConcepts[],
                         java.util.Dictionary attributes) throws MetaphraseException

          Submit a new term for review and possible addition to the given source.

Parameters:

name - the name of the new term.

source - the Source in which the term should be created (as a Atom).

nearestConcept - an existing Concept with a meaning "close to" that intended by the submitted term. Allowed to be null.

note - a free text note for use by the submitter.

relatedConcepts - an array of [additional] Concepts related to the intended meaning of the submitted term.

attributes - arbitrary attribute-value pairs. This is space for a client to place additional information such as the name and/or ID of the user, phone number, name and/or version of the client app, etc.

Returns:

a [temporary] code for use in the application.

Throws:

MetaphraseException - thrown in case of an error accessing Metaphrase.

Overrides:

submitTerm in class Metaphrase

All Packages  Class Hierarchy  This Package  Previous  Next  Index