fr.inria.atlanmod.neoemf.util

Interface UriFactory

All Known Implementing Classes:

AbstractUriFactory, BerkeleyDbUriFactory, BlueprintsUriFactory, HBaseUriFactory, InMemoryUriFactory, MapDbUriFactory, MongoDbUriFactory

@ParametersAreNonnullByDefault
public interface UriFactory

A factory that creates URI instances.

Created URIs are used to locate a PersistentResource and select the BackendFactory to use for persistence.

Method Summary

Modifier and Type	Method and Description
org.eclipse.emf.common.util.URI	createLocalUri(File file) Creates a new URI from the given file descriptor.
org.eclipse.emf.common.util.URI	createLocalUri(String filePath) Creates a new URI from the given file descriptor.
org.eclipse.emf.common.util.URI	createLocalUri(org.eclipse.emf.common.util.URI uri) Creates a new URI from the given uri.
org.eclipse.emf.common.util.URI	createRemoteUri(InetAddress host, int port, String segments) Creates a new URI from the host, port, and model by creating a hierarchical URI that references the distant model resource.
org.eclipse.emf.common.util.URI	createRemoteUri(InetAddress host, int port, org.eclipse.emf.common.util.URI model) Creates a new URI from the host, port, and model by creating a hierarchical URI that references the distant model resource.
org.eclipse.emf.common.util.URI	createRemoteUri(String host, int port, String segments) Creates a new URI from the host, port, and model by creating a hierarchical URI that references the distant model resource.
org.eclipse.emf.common.util.URI	createRemoteUri(String host, int port, org.eclipse.emf.common.util.URI model) Creates a new URI from the host, port, and model by creating a hierarchical URI that references the distant model resource.
static String	createScheme(String baseName) Creates a URI scheme from the specified baseName.
static UriFactory	forName(String name) Retrieves the instance of UriFactory that is associated to a BackendFactory wearing the given name.
static UriFactory	forScheme(String scheme) Retrieves the instance of UriFactory that uses the given scheme.

Method Detail

createScheme

@Nonnull
static String createScheme(String baseName)

Creates a URI scheme from the specified baseName.

Parameters:

baseName - the base name of the scheme

Returns:

the URI scheme

forName

@Nonnull
static UriFactory forName(String name)

Retrieves the instance of UriFactory that is associated to a BackendFactory wearing the given name.

Parameters:

name - the name of the factory

Returns:

a new instance of UriFactory

forScheme

@Nonnull
static UriFactory forScheme(String scheme)

Retrieves the instance of UriFactory that uses the given scheme.

Parameters:

scheme - the scheme of the builder

Returns:

a new instance of UriFactory

createLocalUri

@Nonnull
org.eclipse.emf.common.util.URI createLocalUri(org.eclipse.emf.common.util.URI uri)

Creates a new URI from the given uri.

This method checks that the scheme of the provided uri can be used to create a new UriFactory. Its scheme must be registered in the BackendFactoryRegistry.

Parameters:

uri - the base file-based URI

Returns:

a new URI

Throws:

UnsupportedOperationException - if this URI builder does not support this method

NullPointerException - if the uri is null

IllegalArgumentException - if the scheme of the provided uri is not registered in the BackendFactoryRegistry

createLocalUri

@Nonnull
org.eclipse.emf.common.util.URI createLocalUri(File file)

Creates a new URI from the given file descriptor.

Parameters:

file - the File to build a URI from

Returns:

a new URI

Throws:

UnsupportedOperationException - if this URI builder does not support this method

NullPointerException - if the file is null

createLocalUri

@Nonnull
org.eclipse.emf.common.util.URI createLocalUri(String filePath)

Creates a new URI from the given file descriptor.

Parameters:

filePath - the path of the File to build a URI from

Returns:

a new URI

Throws:

UnsupportedOperationException - if this URI builder does not support this method

NullPointerException - if the filePath is null

createRemoteUri

@Nonnull
org.eclipse.emf.common.util.URI createRemoteUri(String host,
                                                          int port,
                                                          org.eclipse.emf.common.util.URI model)

Creates a new URI from the host, port, and model by creating a hierarchical URI that references the distant model resource.

Parameters:

host - the address of the server (use "localhost" if the server is running locally)

port - the port of the server

model - a URI identifying the model in the database

Returns:

a new URI

Throws:

UnsupportedOperationException - if this URI builder does not support this method

NullPointerException - if any of the parameters is null

IllegalArgumentException - if port < 0

createRemoteUri

@Nonnull
org.eclipse.emf.common.util.URI createRemoteUri(String host,
                                                          int port,
                                                          String segments)

Creates a new URI from the host, port, and model by creating a hierarchical URI that references the distant model resource.

Parameters:

host - the address of the server (use "localhost" if the server is running locally)

port - the port of the server

segments - a string identifying the model in the database

Returns:

a new URI

Throws:

UnsupportedOperationException - if this URI builder does not support this method

NullPointerException - if any of the parameters is null

IllegalArgumentException - if port < 0

createRemoteUri

@Nonnull
org.eclipse.emf.common.util.URI createRemoteUri(InetAddress host,
                                                          int port,
                                                          org.eclipse.emf.common.util.URI model)

Creates a new URI from the host, port, and model by creating a hierarchical URI that references the distant model resource.

Parameters:

host - the address of the server (use "localhost" if the server is running locally)

port - the port of the server

model - a URI identifying the model in the database

Returns:

a new URI

Throws:

UnsupportedOperationException - if this URI builder does not support this method

NullPointerException - if any of the parameters is null

IllegalArgumentException - if port < 0

createRemoteUri

@Nonnull
org.eclipse.emf.common.util.URI createRemoteUri(InetAddress host,
                                                          int port,
                                                          String segments)

Creates a new URI from the host, port, and model by creating a hierarchical URI that references the distant model resource.

Parameters:

host - the address of the server (use "localhost" if the server is running locally)

port - the port of the server

segments - a string identifying the model in the database

Returns:

a new URI

Throws:

UnsupportedOperationException - if this URI builder does not support this method

NullPointerException - if any of the parameters is null

IllegalArgumentException - if port < 0