org.pageseeder.bridge.model

Class PSURI

java.lang.Object

org.pageseeder.bridge.model.PSAddressable

org.pageseeder.bridge.model.PSURI

All Implemented Interfaces:

Serializable, PSEntity

Direct Known Subclasses:

PSDocument, PSExternalURI, PSFolder

public abstract class PSURI
extends PSAddressable

The common base class for folders and documents.

Since:

0.2.0

Version:

0.2.1

Author:

Christophe Lauret

See Also:

Serialized Form

Field Summary

Fields inherited from class org.pageseeder.bridge.model.PSAddressable

DEFAULT_HOST, DEFAULT_PORT, DEFAULT_SCHEME, MAX_PORT_NUMBER

Constructor Summary

Constructors

Constructor and Description
PSURI(String url) Construct a new URI from the specified URL.
PSURI(String scheme, String host, int port, String path) Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
EntityValidity	checkURIValid() Check whether this URI is valid.
Date	getCreatedDate()
String	getDescription()
String	getDisplayTitle() The display title is the title if it's specified, otherwise the url if it's external or else the filename..
String	getDocid()
Long	getId()
String	getIdentifier() Returns the identifier to use when connecting to PageSeeder based on the ID available.
String	getKey()
List<String>	getLabels()
String	getLabelsAsString()
String	getMediaType()
Date	getModifiedDate()
String	getTitle()
boolean	isIdentifiable() Determines whether the entity can be identified in PageSeeder.
boolean	isValid() Determines whether the entity is valid based on known PageSeeder constraints.
void	setCreatedDate(String date)
void	setDescription(String description)
void	setDocid(String docid)
void	setId(Long id)
void	setLabels(List<String> labels)
void	setLabels(String labels)
void	setMediaType(String mediatype)
void	setModifiedDate(String date)
void	setTitle(String title)

Methods inherited from class org.pageseeder.bridge.model.PSAddressable

getHost, getHostURL, getPath, getPort, getScheme, getURL, setHost, setPath, setPort, setScheme, toURL

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pageseeder.bridge.PSEntity

checkValid

Constructor Detail

PSURI

public PSURI(String scheme,
     String host,
     int port,
     String path)

Default constructor.

Parameters:

scheme - The scheme "http" or "https"

host - Where the resource is hosted.

port - The port (or negative to use the default port).

path - The path to the resource.

PSURI

public PSURI(String url)

Construct a new URI from the specified URL.

The URL may omit the scheme or authority part, it which case it will default on the default values from the configuration.

Implementation note: this constructor will decompose the URL into its components.

Parameters:

url - The url.

Throws:

IllegalArgumentException - If the specified URL is invalid

Method Detail

getId

public final Long getId()

Returns:

the private ID of the PageSeeder entity in the database.

getKey

public final String getKey()

Returns:

the public ID for the PageSeeder entity.

isIdentifiable

public boolean isIdentifiable()

Description copied from interface: PSEntity

Determines whether the entity can be identified in PageSeeder.

To be identifiable, the entity must have either a private id or a public id.

If the public ID does not correspond to a single attribute in PageSeeder, then a combination of attributes may be used to determine whether it is possible to identify the entity.

Returns:

true if the object can be identified in PageSeeder; false if it is not possible to identify the entity form its attributes or keys.

getIdentifier

public String getIdentifier()

Description copied from interface: PSEntity

Returns the identifier to use when connecting to PageSeeder based on the ID available.

When both the private and public identifier are available, the private identifier takes precedence over the public one.

When the public identifier cannot be used on its own, then only the private ID is returned.

In general, if the PSEntity.isIdentifiable() method return true, this method should return a value. When it is not the case, it should be clearly documented.

Returns:

the identifier to use when connecting to PageSeeder.

getMediaType

public final String getMediaType()

Returns:

the mediatype

getDocid

public final String getDocid()

Returns:

the Document ID

getDescription

public final String getDescription()

Returns:

the description

getTitle

public final String getTitle()

Returns:

the title

getDisplayTitle

public String getDisplayTitle()

The display title is the title if it's specified, otherwise the url if it's external or else the filename..

Returns:

this URI's display title

getCreatedDate

public final Date getCreatedDate()

Returns:

the created date

getModifiedDate

public final Date getModifiedDate()

Returns:

the modified date

getLabels

public final List<String> getLabels()

Returns:

the labels

setId

public final void setId(Long id)

Parameters:

id - the id to set

setDocid

public final void setDocid(String docid)

Parameters:

docid - the docid to set

setDescription

public final void setDescription(String description)

Parameters:

description - the description to set

setTitle

public final void setTitle(String title)

Parameters:

title - the title to set

setLabels

public final void setLabels(List<String> labels)

Parameters:

labels - the labels to set

setMediaType

public final void setMediaType(String mediatype)

Parameters:

mediatype - the mediatype to set

setCreatedDate

public final void setCreatedDate(String date)

Parameters:

date - the ISO8601 date

setModifiedDate

public final void setModifiedDate(String date)

Parameters:

date - the ISO8601 date

getLabelsAsString

public final String getLabelsAsString()

Returns:

The labels as a comma-separated list.

setLabels

public final void setLabels(String labels)

Parameters:

labels - The labels as a comma-separated list.

checkURIValid

public EntityValidity checkURIValid()

Check whether this URI is valid.

Returns:

the validity of the URI.

isValid

public boolean isValid()

Description copied from interface: PSEntity

Determines whether the entity is valid based on known PageSeeder constraints.

Returns:

true if the object is intrinsically valid based on its internal values; false if any of its attributes violates a PageSeeder constraint.