org.apache.oodt.cas.product.jaxrs.resources

Class ReferenceResource

java.lang.Object

org.apache.oodt.cas.product.jaxrs.resources.ReferenceResource

public class ReferenceResource
extends Object

A JAX-RS resource representing a Reference.

Version:

$Revision$

Author:

rlaidlaw

Constructor Summary

Constructors

Constructor and Description
ReferenceResource() Default constructor required by JAXB.
ReferenceResource(String productId, int refIndex, Reference reference, File workingDir) Constructor that sets the reference and working directory for the resource.

Method Summary

Modifier and Type	Method and Description
String	getDataStoreReference() Gets the data store reference for the reference.
long	getFileSize() Gets the file size for the reference.
org.apache.tika.mime.MimeType	getMimeType() Gets the MIME type for the reference.
String	getMimeTypeName() Gets the name of the MIME type for the reference.
String	getOrigReference() Gets the original reference for the reference.
String	getProductId() Gets the ID of the product that the reference belongs to.
Reference	getReference() Gets the reference.
int	getRefIndex() Gets the index of the reference within its product.
File	getWorkingDir() Gets the working directory for the reference.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReferenceResource

public ReferenceResource()

Default constructor required by JAXB.

ReferenceResource

public ReferenceResource(String productId,
                         int refIndex,
                         Reference reference,
                         File workingDir)

Constructor that sets the reference and working directory for the resource.

Parameters:

productId - the ID of the product that the reference belongs to

refIndex - the index of the reference within its product

reference - the reference for the resource

workingDir - the working directory for creating temporary files to attach to responses

Method Detail

getReference

public Reference getReference()

Gets the reference.

Returns:

the reference

getWorkingDir

public File getWorkingDir()

Gets the working directory for the reference.

Returns:

the working directory

getProductId

public String getProductId()

Gets the ID of the product that the reference belongs to.

Returns:

the ID of the product that the reference belongs to

getRefIndex

public int getRefIndex()

Gets the index of the reference within its product.

Returns:

the index of the reference within its product

getDataStoreReference

public String getDataStoreReference()

Gets the data store reference for the reference.

Returns:

the data store reference for the reference

getFileSize

public long getFileSize()

Gets the file size for the reference.

Returns:

the file size for the reference

getMimeTypeName

public String getMimeTypeName()

Gets the name of the MIME type for the reference.

Returns:

the name of the MIME type for the reference

getMimeType

public org.apache.tika.mime.MimeType getMimeType()

Gets the MIME type for the reference.

Returns:

the MIME type for the reference

getOrigReference

public String getOrigReference()

Gets the original reference for the reference.

Returns:

the original reference for the reference