org.ogf.saga.isn
Class ISNFactory

java.lang.Object
  org.ogf.saga.isn.ISNFactory

public abstract class ISNFactory
extends Object

Factory for objects of the information system navigator package.

Constructor Summary

ISNFactory()

Method Summary

static EntityDataSet	createEntityDataSet(String model, String entityName, String filter) Creates an EntityDataSet that contains the set of entities that pass the specified filter.
static EntityDataSet	createEntityDataSet(String model, String entityName, String filter, Session session) Creates an EntityDataSet that contains the set of entities that pass the specified filter.
static EntityDataSet	createEntityDataSet(String model, String entityName, String filter, Session session, URL infoSystemUrl) Creates an EntityDataSet that contains the set of entities that pass the specified filter.
static EntityDataSet	createEntityDataSet(String sagaFactoryClassname, String model, String entityName, String filter) Creates an EntityDataSet that contains the set of entities that pass the specified filter.
static EntityDataSet	createEntityDataSet(String sagaFactoryClassname, String model, String entityName, String filter, Session session) Creates an EntityDataSet that contains the set of entities that pass the specified filter.
static EntityDataSet	createEntityDataSet(String sagaFactoryClassname, String model, String entityName, String filter, Session session, URL infoSystemUrl) Creates an EntityDataSet that contains the set of entities that pass the specified filter.
protected abstract EntityDataSet	doCreateEntityDataSet(String model, String entityName, String filter, Session session) Creates a EntityDataSet with the default URL.
protected abstract EntityDataSet	doCreateEntityDataSet(String model, String entityName, String filter, Session session, URL infoSystemUrl) Creates a EntityDataSet.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ISNFactory

public ISNFactory()

Method Detail

doCreateEntityDataSet

protected abstract EntityDataSet doCreateEntityDataSet(String model,
                                                       String entityName,
                                                       String filter,
                                                       Session session)
                                                throws BadParameterException,
                                                       DoesNotExistException,
                                                       NoSuccessException

Creates a EntityDataSet with the default URL. To be provided by the implementation.

Parameters:

model - a string containing the name of the information model

entityName - a string containing the name of the entity to navigate

filter - a string containing the filter for filtering entities, may be null

session - the session handle, the default session

Returns:

the entityDataSet instance

Throws:

BadParameterException - if the related name is not valid, or the filter is not valid

DoesNotExistException - if the url is syntactically valid, but no service can be contacted at that URL

NoSuccessException - if no result can be returned because of information system or other internal problems

NotImplementedException - if not implemented by that SAGA implementation at all

doCreateEntityDataSet

protected abstract EntityDataSet doCreateEntityDataSet(String model,
                                                       String entityName,
                                                       String filter,
                                                       Session session,
                                                       URL infoSystemUrl)
                                                throws BadParameterException,
                                                       DoesNotExistException,
                                                       NoSuccessException

Creates a EntityDataSet. To be provided by the implementation.

Parameters:

model - a string containing the name of the information model

entityName - a string containing the name of the entity to navigate

filter - a string containing the filter for filtering entities, may be null

session - the session handle, may be null to denote the default session

infoSystemUrl - the URL to guide the implementation, may be null

Returns:

the entityDataSet instance

Throws:

BadParameterException - if the related name is not valid, or the filter is not valid

DoesNotExistException - if the url is syntactically valid, but no service can be contacted at that URL

NoSuccessException - if no result can be returned because of information system or other internal problems

NotImplementedException - if not implemented by that SAGA implementation at all

createEntityDataSet

public static EntityDataSet createEntityDataSet(String model,
                                                String entityName,
                                                String filter)
                                         throws BadParameterException,
                                                DoesNotExistException,
                                                NoSuccessException,
                                                NotImplementedException

Creates an EntityDataSet that contains the set of entities that pass the specified filter. The filter MUST only include attributes from the named entity. Details about the filter can be found in the package description.

Parameters:

model - a string containing the name of the information model

entityName - a string containing the name of the entity to navigate

filter - a string containing the filter for filtering entities, may be null

Returns:

the entityDataSet instance

Throws:

BadParameterException - if the related name is not valid, or the filter is not valid

DoesNotExistException - if the url is syntactically valid, but no service can be contacted at that URL

NoSuccessException - if no result can be returned because of information system or other internal problems

NotImplementedException - if not implemented by that SAGA implementation at all

createEntityDataSet

public static EntityDataSet createEntityDataSet(String sagaFactoryClassname,
                                                String model,
                                                String entityName,
                                                String filter)
                                         throws BadParameterException,
                                                DoesNotExistException,
                                                NoSuccessException,
                                                NotImplementedException

Creates an EntityDataSet that contains the set of entities that pass the specified filter. The filter MUST only include attributes from the named entity. Details about the filter can be found in the package description.

Parameters:

sagaFactoryClassname - the class name of the Saga factory to be used.

model - a string containing the name of the information model

entityName - a string containing the name of the entity to navigate

filter - a string containing the filter for filtering entities, may be null

Returns:

the entityDataSet instance

Throws:

BadParameterException - if the related name is not valid, or the filter is not valid

DoesNotExistException - if the url is syntactically valid, but no service can be contacted at that URL

NoSuccessException - if no result can be returned because of information system or other internal problems

NotImplementedException - if not implemented by that SAGA implementation at all

createEntityDataSet

public static EntityDataSet createEntityDataSet(String model,
                                                String entityName,
                                                String filter,
                                                Session session)
                                         throws BadParameterException,
                                                DoesNotExistException,
                                                NoSuccessException,
                                                NotImplementedException

Creates an EntityDataSet that contains the set of entities that pass the specified filter. The filter MUST only include attributes from the named entity. Details about the filter can be found in the package description.

Parameters:

model - a string containing the name of the information model

entityName - a string containing the name of the entity to navigate

filter - a string containing the filter for filtering entities, may be null

session - the session handle, may be null to denote the default session

Returns:

the entityDataSet instance

Throws:

BadParameterException - if the related name is not valid, or the filter is not valid

DoesNotExistException - if the url is syntactically valid, but no service can be contacted at that URL

NoSuccessException - if no result can be returned because of information system or other internal problems

NotImplementedException - if not implemented by that SAGA implementation at all

createEntityDataSet

public static EntityDataSet createEntityDataSet(String sagaFactoryClassname,
                                                String model,
                                                String entityName,
                                                String filter,
                                                Session session)
                                         throws BadParameterException,
                                                DoesNotExistException,
                                                NoSuccessException,
                                                NotImplementedException

Creates an EntityDataSet that contains the set of entities that pass the specified filter. The filter MUST only include attributes from the named entity. Details about the filter can be found in the package description.

Parameters:

sagaFactoryClassname - the class name of the Saga factory to be used.

model - a string containing the name of the information model

entityName - a string containing the name of the entity to navigate

filter - a string containing the filter for filtering entities, may be null

session - the session handle, may be null to denote the default session

Returns:

the entityDataSet instance

Throws:

BadParameterException - if the related name is not valid, or the filter is not valid

DoesNotExistException - if the url is syntactically valid, but no service can be contacted at that URL

NoSuccessException - if no result can be returned because of information system or other internal problems

NotImplementedException - if not implemented by that SAGA implementation at all

createEntityDataSet

public static EntityDataSet createEntityDataSet(String model,
                                                String entityName,
                                                String filter,
                                                Session session,
                                                URL infoSystemUrl)
                                         throws BadParameterException,
                                                DoesNotExistException,
                                                NoSuccessException,
                                                NotImplementedException

Creates an EntityDataSet that contains the set of entities that pass the specified filter. The filter MUST only include attributes from the named entity. Details about the filter can be found in the package description. The url specified as an input parameter is to assist the implementation to locate the underlying information system such that it can be queried.

Parameters:

model - a string containing the name of the information model

entityName - a string containing the name of the entity to navigate

filter - a string containing the filter for filtering entities, may be null

session - the session handle, may be null to denote the default session

infoSystemUrl - the URL to guide the implementation, may be null

Returns:

the entityDataSet instance

Throws:

BadParameterException - if the related name is not valid, or the filter is not valid

DoesNotExistException - if the url is syntactically valid, but no service can be contacted at that URL

NoSuccessException - if no result can be returned because of information system or other internal problems

NotImplementedException - if not implemented by that SAGA implementation at all

createEntityDataSet

public static EntityDataSet createEntityDataSet(String sagaFactoryClassname,
                                                String model,
                                                String entityName,
                                                String filter,
                                                Session session,
                                                URL infoSystemUrl)
                                         throws BadParameterException,
                                                DoesNotExistException,
                                                NoSuccessException,
                                                NotImplementedException

Creates an EntityDataSet that contains the set of entities that pass the specified filter. The filter MUST only include attributes from the named entity. Details about the filter can be found in the package description. The url specified as an input parameter is to assist the implementation to locate the underlying information system such that it can be queried.

Parameters:

sagaFactoryClassname - the class name of the Saga factory to be used.

model - a string containing the name of the information model

entityName - a string containing the name of the entity to navigate

filter - a string containing the filter for filtering entities, may be null

session - the session handle, may be null to denote the default session

infoSystemUrl - the URL to guide the implementation, may be null

Returns:

the entityDataSet instance

Throws:

BadParameterException - if the related name is not valid, or the filter is not valid

DoesNotExistException - if the url is syntactically valid, but no service can be contacted at that URL

NoSuccessException - if no result can be returned because of information system or other internal problems

NotImplementedException - if not implemented by that SAGA implementation at all