org.knime.core.util.pathresolve

Interface URIToFileResolve

public interface URIToFileResolve

A service interface to convert a URI into a local file. The URI is usually (always?) either a file URI or a URI pointing into the KNIME TeamSpace (also file based), e.g. "knime:/MOUNT_ID/some/path/workflow.knime".

This interface is used to resolve URIs that are stored as part of referenced metanode templates. It is not meant to be implemented by third-party plug-ins.

Author:

Bernd Wiswedel, KNIME.com, Zurich, Switzerland

No public API: not to be implemented by clients

Method Summary

Modifier and Type	Method and Description
boolean	isMountpointRelative(URI uri) Returns true, if this is a URI that is relative to the current mountpoint (of the flow it is used in).
boolean	isNodeRelative(URI uri) Returns true, if this is a URI that is relative to the node it is used in.
boolean	isWorkflowRelative(URI uri) Returns true, if this is a URI that is relative to the workflow it is used in.
File	resolveToFile(URI uri) Resolves the given URI into a local file.
File	resolveToFile(URI uri, org.eclipse.core.runtime.IProgressMonitor monitor) Resolves the given URI into a local file.
File	resolveToLocalOrTempFile(URI uri) Resolves the given URI into a local file.
File	resolveToLocalOrTempFile(URI uri, org.eclipse.core.runtime.IProgressMonitor monitor) Resolves the given URI into a local file.

Method Detail

resolveToFile

File resolveToFile(URI uri)
            throws IOException

Resolves the given URI into a local file. If the URI doesn't denote a local file, null is returned.

Parameters:

uri - The URI, e.g. "knime:/MOUNT_ID/some/path/workflow.knime"

Returns:

the local file represented by the URI or null

Throws:

IOException - If the URI can't be resolved

resolveToFile

File resolveToFile(URI uri,
                   org.eclipse.core.runtime.IProgressMonitor monitor)
            throws IOException

Resolves the given URI into a local file. If the URI doesn't denote a local file, null is returned.

Parameters:

uri - The URI, e.g. "knime:/MOUNT_ID/some/path/workflow.knime"

monitor - a progress monitor, must not be null

Returns:

the local file represented by the URI or null

Throws:

IOException - If the URI can't be resolved

Since:

2.6

resolveToLocalOrTempFile

File resolveToLocalOrTempFile(URI uri)
                       throws IOException

Resolves the given URI into a local file. If the URI does not represent a local file (e.g. a remote file on a server) it is downloaded first to a temporary directory and the the temporary copy is returned. If it represents a local file the behavior is the same as in resolveToFile(URI).

Parameters:

uri - The URI, e.g. "knime:/MOUNT_ID/some/path/workflow.knime"

Returns:

the file represented by the URI or a temporary copy of that file if it represents a remote file

Throws:

IOException - If the URI can't be resolved

resolveToLocalOrTempFile

File resolveToLocalOrTempFile(URI uri,
                              org.eclipse.core.runtime.IProgressMonitor monitor)
                       throws IOException

Resolves the given URI into a local file. If the URI does not represent a local file (e.g. a remote file on a server) it is downloaded first to a temporary directory and the the temporary copy is returned. If it represents a local file the behavior is the same as in resolveToFile(URI).

Parameters:

uri - The URI, e.g. "knime:/MOUNT_ID/some/path/workflow.knime"

monitor - a progress monitor, must not be null

Returns:

the file represented by the URI or a temporary copy of that file if it represents a remote file

Throws:

IOException - If the URI can't be resolved

Since:

2.6

isMountpointRelative

boolean isMountpointRelative(URI uri)

Returns true, if this is a URI that is relative to the current mountpoint (of the flow it is used in). It can only be resolved in the context of a flow. Contains the corresponding keyword as host.

Parameters:

uri - to check

Returns:

true if argument URI is mount point relative, false if not.

Since:

2.8

isWorkflowRelative

boolean isWorkflowRelative(URI uri)

Returns true, if this is a URI that is relative to the workflow it is used in. It can only be resolved in the context of a flow. Contains the corresponding keyword as host.

Parameters:

uri - to check

Returns:

true if argument URI is workflow relative, false if not.

Since:

2.8

isNodeRelative

boolean isNodeRelative(URI uri)

Returns true, if this is a URI that is relative to the node it is used in. It can only be resolved in the context of a flow. Contains the corresponding keyword as host.

Parameters:

uri - to check

Returns:

true if argument URI is node relative, false if not.

Since:

2.10