fr.inria.atlanmod.neoemf.util

Class AbstractUriFactory

java.lang.Object

fr.inria.atlanmod.neoemf.util.AbstractUriFactory

All Implemented Interfaces:

UriFactory

Direct Known Subclasses:

BerkeleyDbUriFactory, BlueprintsUriFactory, HBaseUriFactory, InMemoryUriFactory, MapDbUriFactory, MongoDbUriFactory

@ParametersAreNonnullByDefault
public abstract class AbstractUriFactory
extends Object
implements UriFactory

An abstract UriFactory that manages the assembly and the construction of URIs.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractUriFactory(boolean supportsLocal, boolean supportsRemote) Constructs a new default AbstractUriFactory.
protected	AbstractUriFactory(String scheme, boolean supportsLocal, boolean supportsRemote) Constructs a new AbstractUriFactory with the given scheme.

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 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(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 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, 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.
protected String	scheme() Gets the scheme to identify the BackendFactory to use.
protected boolean	supportsLocalUris() Checks that the BackendFactory associated to the created URI supports file-based storage.
protected boolean	supportsRemoteUris() Checks that the BackendFactory associated to the created URI supports server-based storage.

Methods inherited from class java.lang.Object

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

Methods inherited from interface fr.inria.atlanmod.neoemf.util.UriFactory

createScheme, forName, forScheme

Constructor Detail

AbstractUriFactory

protected AbstractUriFactory(boolean supportsLocal,
                             boolean supportsRemote)

Constructs a new default AbstractUriFactory.

Parameters:

supportsLocal - true if file-based URIs are supported

supportsRemote - true if server-based URIs are supported

AbstractUriFactory

protected AbstractUriFactory(String scheme,
                             boolean supportsLocal,
                             boolean supportsRemote)

Constructs a new AbstractUriFactory with the given scheme.

Parameters:

scheme - the scheme to identify the BackendFactory to use

supportsLocal - true if file-based URIs are supported

supportsRemote - true if server-based URIs are supported

Method Detail

scheme

@Nonnull
protected final String scheme()

Gets the scheme to identify the BackendFactory to use.

Returns:

the URI scheme

supportsLocalUris

protected boolean supportsLocalUris()

Checks that the BackendFactory associated to the created URI supports file-based storage.

Returns:

true if file-based URIs are supported

supportsRemoteUris

protected boolean supportsRemoteUris()

Checks that the BackendFactory associated to the created URI supports server-based storage.

Returns:

true if server-based URIs are supported

createLocalUri

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

Description copied from interface: UriFactory

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.

Specified by:

createLocalUri in interface UriFactory

Parameters:

uri - the base file-based URI

Returns:

a new URI

createLocalUri

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

Description copied from interface: UriFactory

Creates a new URI from the given file descriptor.

Specified by:

createLocalUri in interface UriFactory

Parameters:

file - the File to build a URI from

Returns:

a new URI

createLocalUri

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

Description copied from interface: UriFactory

Creates a new URI from the given file descriptor.

Specified by:

createLocalUri in interface UriFactory

Parameters:

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

Returns:

a new URI

createRemoteUri

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

Description copied from interface: UriFactory

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

Specified by:

createRemoteUri in interface UriFactory

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

createRemoteUri

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

Description copied from interface: UriFactory

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

Specified by:

createRemoteUri in interface UriFactory

Parameters:

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

port - the port of the server

model - a string identifying the model in the database

Returns:

a new URI

createRemoteUri

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

Description copied from interface: UriFactory

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

Specified by:

createRemoteUri in interface UriFactory

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

createRemoteUri

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

Description copied from interface: UriFactory

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

Specified by:

createRemoteUri in interface UriFactory

Parameters:

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

port - the port of the server

model - a string identifying the model in the database

Returns:

a new URI