uws.job

Class Result

java.lang.Object

uws.job.SerializableUWSObject

uws.job.Result

All Implemented Interfaces:

java.io.Serializable

public class Result
extends SerializableUWSObject

This class gives a short description (mainly an ID and a URL) of a job result.

Version:

4.1 (09/2017)

Author:

Grégory Mantelet (CDS;ARI)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_RESULT_NAME
protected java.lang.String	href [Optional] The readable URL which points toward the result file.
protected java.lang.String	id [Required ; Default="result"] Name or ID of this result.
protected java.lang.String	mimeType [Optional] The MIME type of the result.
protected boolean	redirection Tells whether a redirection toward the given URL is required to get the result content.
protected long	size [Optional] The size of the corresponding result file.
protected java.lang.String	type [Optional] The XLINK URL type (simple (default), extended, locator, arc, resource, title or none ; see http://www.w3.org/TR/xlink/#linking-elements for more details).

Constructor Summary

Constructors

Constructor and Description
Result(java.lang.String name, java.lang.String resultType, java.lang.String resultUrl, boolean redirection) Builds MANUALLY a result with an ID/name, a result type and the URL toward the file which contains the result content.
Result(UWSJob job, java.lang.String name) Builds a result with just a name/ID.
Result(UWSJob job, java.lang.String name, java.lang.String resultUrl) Builds a result with an ID/name and the URL toward the file which contains the result content.
Result(UWSJob job, java.lang.String name, java.lang.String resultType, java.lang.String resultUrl) Builds a result with an ID/name, a result type and the URL toward the file which contains the result content.
Result(UWSJob job, java.net.URL resultUrl) Builds a result with the URL toward the file which contains the result content.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getDefaultUrl(java.lang.String id, UWSJob job) Gets the HREF as {jobList}/{job}/results/ID.
java.lang.String	getHref() Gets the URL of the result file.
java.lang.String	getId() Gets the id/name of this result.
java.lang.String	getMimeType() Gets the MIME type of this result.
long	getSize() Gets the size of the corresponding result file.
java.lang.String	getType() Get the type of this result.
boolean	isRedirectionRequired() Tells whether a redirection toward the URL of this result is required to get the result content.
static boolean	isRedirectionUrl(java.lang.String url, java.lang.String resultId, UWSJob job) Tells whether the given URL is different from the default URL of the specified result of the given job.
java.lang.String	serialize(UWSSerializer serializer, JobOwner owner) Serializes the whole object considering the given owner (supposed to be the current user) and thanks to the given serializer.
void	setMimeType(java.lang.String mimeType) Sets the MIME type of this result.
void	setSize(long size) Sets the size (in bytes) of the corresponding result file.
java.lang.String	toString()

Methods inherited from class uws.job.SerializableUWSObject

serialize, serialize, serialize

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_RESULT_NAME

public static final java.lang.String DEFAULT_RESULT_NAME

See Also:

Constant Field Values

id

protected java.lang.String id

[Required ; Default="result"] Name or ID of this result.

href

protected java.lang.String href

[Optional] The readable URL which points toward the result file.

type

protected java.lang.String type

[Optional] The XLINK URL type (simple (default), extended, locator, arc, resource, title or none ; see http://www.w3.org/TR/xlink/#linking-elements for more details).

mimeType

protected java.lang.String mimeType

[Optional] The MIME type of the result.

size

protected long size

[Optional] The size of the corresponding result file.

redirection

protected final boolean redirection

Tells whether a redirection toward the given URL is required to get the result content. If FALSE, the content must be read from the corresponding file managed by the UWSFileManager.

Constructor Detail

Result

public Result(UWSJob job,
              java.net.URL resultUrl)

Builds a result with the URL toward the file which contains the result content.

Parameters:

job - Job which will own this result.

resultUrl - Result file URL.

Result

public Result(UWSJob job,
              java.lang.String name)

Builds a result with just a name/ID.

Parameters:

job - Job which will own this result.

name - Name of ID of the result.

Result

public Result(UWSJob job,
              java.lang.String name,
              java.lang.String resultUrl)

Builds a result with an ID/name and the URL toward the file which contains the result content.

Parameters:

job - Job which will own this result.

name - Name or ID of the result.

resultUrl - Result file URL.

See Also:

Result(UWSJob, String)

Result

public Result(UWSJob job,
              java.lang.String name,
              java.lang.String resultType,
              java.lang.String resultUrl)

Builds a result with an ID/name, a result type and the URL toward the file which contains the result content.

Parameters:

job - Job which will own this result.

name - Name or ID or the result.

resultType - Type of result. Note: it should be a XLINK URL type (one among simple (default), extended, locator, arc, resource, title or none ; see http://www.w3.org/TR/xlink/#linking-elements for more details).

resultUrl - Result file URL.

See Also:

Result(UWSJob, String, String)

Result

public Result(java.lang.String name,
              java.lang.String resultType,
              java.lang.String resultUrl,
              boolean redirection)

Builds MANUALLY a result with an ID/name, a result type and the URL toward the file which contains the result content.

Parameters:

name - Name or ID or the result.

resultType - Type of result. Note: it should be a XLINK URL type (one among simple (default), extended, locator, arc, resource, title or none ; see http://www.w3.org/TR/xlink/#linking-elements for more details).

resultUrl - Result file URL.

redirection - true if a redirection toward the given URL is required to get the result content, false otherwise. note: This parameter is ignored if the given URL is NULL or empty ! In this case, redirection = FALSE.

Method Detail

getDefaultUrl

public static final java.lang.String getDefaultUrl(java.lang.String id,
                                                   UWSJob job)

Gets the HREF as {jobList}/{job}/results/ID.

Parameters:

id - ID of the concerned Result.

job - The job which has to contain the Result instance.

Returns:

The HREF field of the Result or null if the URL of the job is unknown (which is the case when the job is not in a job list).

isRedirectionUrl

public static final boolean isRedirectionUrl(java.lang.String url,
                                             java.lang.String resultId,
                                             UWSJob job)

Tells whether the given URL is different from the default URL of the specified result of the given job.

When this function returns true a redirection toward the given URL is required to get the result content. Otherwise, the result content must be read from a file managed by the UWSFileManager.

note: If at least one of the parameter of this function is null or an empty string, this function returns false.

Parameters:

url - Result URL to test.

resultId - ID of the result.

job - Job which owns the result.

Returns:

true if a redirection is required to get the result content, false otherwise.

See Also:

getDefaultUrl(String, UWSJob)

getId

public final java.lang.String getId()

Gets the id/name of this result.

Returns:

The result id or name.

getHref

public final java.lang.String getHref()

Gets the URL of the result file.

Returns:

The result file URL.

isRedirectionRequired

public final boolean isRedirectionRequired()

Tells whether a redirection toward the URL of this result is required to get the result content. If NOT, its content must be read from the corresponding file managed by the UWSFileManager.

Returns:

true if a redirection is required to get the result content, false otherwise.

getType

public final java.lang.String getType()

Get the type of this result.

Note: The returned type should be a XLINK URL type (one among simple (default), extended, locator, arc, resource, title or none ; see http://www.w3.org/TR/xlink/#linking-elements for more details).

Returns:

The result type.

getMimeType

public final java.lang.String getMimeType()

Gets the MIME type of this result.

Returns:

The MIME Type.

setMimeType

public final void setMimeType(java.lang.String mimeType)

Sets the MIME type of this result.

Parameters:

mimeType - The MIME type to set.

getSize

public final long getSize()

Gets the size of the corresponding result file.

Returns:

Result file size (in bytes).

setSize

public final void setSize(long size)

Sets the size (in bytes) of the corresponding result file.

serialize

public java.lang.String serialize(UWSSerializer serializer,
                                  JobOwner owner)
                           throws UWSException,
                                  java.lang.Exception

Description copied from class: SerializableUWSObject

Serializes the whole object considering the given owner (supposed to be the current user) and thanks to the given serializer.

Specified by:

serialize in class SerializableUWSObject

Parameters:

serializer - The serializer to use.

owner - The current user.

Returns:

The serialized representation of this object.

Throws:

UWSException - If the owner is not allowed to see the content of the serializable object.

java.lang.Exception - If there is any other error during the serialization.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object