org.apache.oodt.cas.filemgr.structs

Class Reference

java.lang.Object

org.apache.oodt.cas.filemgr.structs.Reference

public class Reference
extends Object

Version:

$Revision$

A reference stores the original item reference, and also the item's data store reference, which describes its location within the data store.

Author:

mattmann, bfoster

Field Summary

Fields

Modifier and Type	Field and Description
static String	STREAM_REFERENCE_DELIMITER

Constructor Summary

Constructors

Constructor and Description
Reference() Default constructor
Reference(Reference r) Copy Constructor
Reference(String origRef, String dataRef, long size) Constructs a new Reference with the specified parameters.
Reference(String origRef, String dataRef, long size, org.apache.tika.mime.MimeType mime) Constructs a new Reference with the specified parameters.

Method Summary

Modifier and Type	Method and Description
String	getDataStoreReference()
long	getFileSize()
org.apache.tika.mime.MimeType	getMimeType()
String	getOrigReference()
void	setDataStoreReference(String dataStoreReference)
void	setFileSize(long fileSize)
void	setMimeType(org.apache.tika.mime.MimeType mime)
void	setMimeType(String name)
void	setOrigReference(String origReference)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

STREAM_REFERENCE_DELIMITER

public static String STREAM_REFERENCE_DELIMITER

Constructor Detail

Reference

public Reference(Reference r)

Copy Constructor

Parameters:

r - The Reference object to copy

Reference

public Reference()

Default constructor

Reference

public Reference(String origRef,
                 String dataRef,
                 long size)

Constructs a new Reference with the specified parameters.

Parameters:

origRef - The item's original location.

dataRef - The item's location within the data store.

size - The size of the file that this reference refers to.

Reference

public Reference(String origRef,
                 String dataRef,
                 long size,
                 org.apache.tika.mime.MimeType mime)

Constructs a new Reference with the specified parameters. In particular, a MimeType object is explicitly supplied. This object represents the mime-type of the item this reference refers to

Parameters:

origRef - The item's original location.

dataRef - The item's location within the data store.

size - The size of the file that this reference refers to.

mime - A MimeType object representing the mime-type of the item

Method Detail

getDataStoreReference

public String getDataStoreReference()

Returns:

Returns the dataStoreReference.

setDataStoreReference

public void setDataStoreReference(String dataStoreReference)

Parameters:

dataStoreReference - The dataStoreReference to set.

getOrigReference

public String getOrigReference()

Returns:

Returns the origReference.

setOrigReference

public void setOrigReference(String origReference)

Parameters:

origReference - The origReference to set.

getFileSize

public long getFileSize()

Returns:

Returns the fileSize.

setFileSize

public void setFileSize(long fileSize)

Parameters:

fileSize - The fileSize to set.

getMimeType

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

Returns:

returns a MimeType obj representing the mime-type of this reference

setMimeType

public void setMimeType(org.apache.tika.mime.MimeType mime)

Parameters:

mime - the MimeType object to set for this reference

setMimeType

public void setMimeType(String name)

Parameters:

name - the String name of the mimetype of this reference

toString

public String toString()

Overrides:

toString in class Object