net.refractions.udig.catalog.ui
Interface UDIGConnectionPage

All Known Implementing Classes:

AbstractProprietaryDatastoreWizardPage, AbstractUDIGImportPage, DataBaseRegistryWizardPage, DataConnectionPage, DataStoreWizardPage, FileConnectionPage, NewServiceConnectionPage, UserHostPage

public interface UDIGConnectionPage

A udig import wizard page is responsible for providing a user interface which is used to gather connection information for a specific service.

It is not strictly required but it is highly recommended that the implementation be a subclass of AbstractUDIGImportPage.

Since:

0.9.0

Author:

jeichar

See Also:

AbstractUDIGImportPage

Method Summary

java.util.Map<java.lang.String,java.io.Serializable>	getParams() Deprecated.
java.util.Collection<java.net.URL>	getResourceIDs() Returns the ids of the GeoResource to use as the "selected" resources.
java.util.Collection<IService>	getServices() Returns the services that the wizard needs to add to the catalog.
void	setErrorMessage(java.lang.String newMessage) Sets or clears the error message for this page.

Method Detail

getParams

java.util.Map<java.lang.String,java.io.Serializable> getParams()

Deprecated.

Returns the connection parameters stored by the connection page. If this is not the final page in the sequence of pages null(or anything else) may be returned.

Returns:

A map of connection parameters.

getServices

java.util.Collection<IService> getServices()

Returns the services that the wizard needs to add to the catalog.

getResourceIDs

java.util.Collection<java.net.URL> getResourceIDs()

Returns the ids of the GeoResource to use as the "selected" resources. If a non-empty collection is returned then the next states in the wizard "should" use these as the items selected by the user.

Example: The postgis wizard pages permits the user to select the table of interest. When moving to a new state (for example the Resource Selection State in net.refractions.udig.project.ui) that state should use that as the selected IGeoResources if it needs a selection of IGeoResources
In the ResourceSelectionState example it would use this collection and not need to query the user with a wizard page for that input

Returns:

the ids of the GeoResource to use as the "selected" resources.

setErrorMessage

void setErrorMessage(java.lang.String newMessage)

Sets or clears the error message for this page.

Parameters:

newMessage - the message, or null to clear the error message