sirius.biz.jdbc.storage

Class StoredObjectRef

java.lang.Object

sirius.biz.jdbc.storage.StoredObjectRef

public class StoredObjectRef
extends Object

Represents a reference to a StoredObject which can be placed as field within an BaseEntity.

If the owning entity is deleted, the referenced object is also deleted if it was uploaded specifically for this reference. If it was a shared object from within a bucket, the referenced object remains untouched.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	changed
protected String	reference

Constructor Summary

Constructors

Constructor and Description
StoredObjectRef(String bucket) Creates a new reference for the given bucket and owner.
StoredObjectRef(String bucket, boolean supportsURL) Creates a new reference for the given bucket and owner.

Method Summary

Modifier and Type	Method and Description
String	getBucket() Returns the bucket in which referenced objects are stored.
String	getFilename() Determines the filename of the referenced file or url.
String	getKey() Returns the key of the referenced object.
StoredObject	getObject() Returns the referenced object or null.
String	getReference() Returns the effective reference used for VirtualObject.REFERENCE.
String	getURL(String defaultURL) Determines the URL for this reference.
String	getURLWithVersion(String version, String defaultURL) Determines the URL for this reference.
String	getURLWithVersionAndAddonText(String version, String addonText, String defaultURL) Determines the URL for this reference.
boolean	isEmpty() Determines if no object or an URL is being referenced.
boolean	isFetched() Determines if the referenced object was fetched already.
boolean	isFilled() Determines if an object or an URL is being referenced.
boolean	isSupportsURL() Determines if this reference also supports to store URLs instead of object keys.
boolean	isURL() Determines if an URL was stored instead of an object key.
void	setKey(String key) Specifies an object key to reference.
void	setObject(StoredObject object) Assigns an object to be referenced.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

changed

protected boolean changed

reference

protected String reference

Constructor Detail

StoredObjectRef

public StoredObjectRef(String bucket,
                       boolean supportsURL)

Creates a new reference for the given bucket and owner.

Parameters:

bucket - the bucket to place referenced objects in

supportsURL - if true a URL can also be used instead of an object key

StoredObjectRef

public StoredObjectRef(String bucket)

Creates a new reference for the given bucket and owner.

Parameters:

bucket - the bucket to place referenced objects in

Method Detail

getObject

public StoredObject getObject()

Returns the referenced object or null.

Returns:

the referenced object or null if there is no referenced object

setObject

public void setObject(StoredObject object)

Assigns an object to be referenced.

Parameters:

object - the object to be referenced

getURL

public String getURL(String defaultURL)

Determines the URL for this reference. Returns either the URL if the reference is an external one, or the URL for the StoredObject if it exists, otherwise the default URL.

Parameters:

defaultURL - the default URL

Returns:

the URL for this reference

getURLWithVersion

public String getURLWithVersion(String version,
                                String defaultURL)

Determines the URL for this reference. Returns either the URL if the reference is an external one, or the versioned URL for the StoredObject if it exists, otherwise the default URL.

Parameters:

version - the version string

defaultURL - the default URL

Returns:

the URL for this reference

getURLWithVersionAndAddonText

public String getURLWithVersionAndAddonText(String version,
                                            String addonText,
                                            String defaultURL)

Determines the URL for this reference. Returns either the URL if the reference is an external one, or the versioned URL for the StoredObject if it exists, otherwise the default URL.

Parameters:

version - the version string

addonText - the addon text to add to the generated URL

defaultURL - the default URL

Returns:

the URL for this reference

setKey

public void setKey(String key)

Specifies an object key to reference.

Parameters:

key - the key of the object to reference

getFilename

public String getFilename()

Determines the filename of the referenced file or url.

Returns:

the filename, or null if no object is referenced

getKey

public String getKey()

Returns the key of the referenced object.

Returns:

the key of the object being referenced

isURL

public boolean isURL()

Determines if an URL was stored instead of an object key.

Returns:

true if an URL was stored, false if an object key or nothing yet is stored

isFilled

public boolean isFilled()

Determines if an object or an URL is being referenced.

Returns:

true if a reference or an URL is present, false otherwise

isEmpty

public boolean isEmpty()

Determines if no object or an URL is being referenced.

Returns:

true if no reference or URL is present, false otherwise

isFetched

public boolean isFetched()

Determines if the referenced object was fetched already.

Returns:

true if the object is fetched, false otherwise

toString

public String toString()

Overrides:

toString in class Object

getBucket

public String getBucket()

Returns the bucket in which referenced objects are stored.

Returns:

the name of the bucket in which referenced objects are stored

isSupportsURL

public boolean isSupportsURL()

Determines if this reference also supports to store URLs instead of object keys.

Returns:

true if URLs can be stored in this reference, false otherwise

getReference

public String getReference()

Returns the effective reference used for VirtualObject.REFERENCE.

Returns:

the reference to use or an empty string of the owning object has not been saved yet.