org.pageseeder.bridge.model

Class PSDocument

java.lang.Object

org.pageseeder.bridge.model.PSAddressable

org.pageseeder.bridge.model.PSURI

org.pageseeder.bridge.model.PSDocument

All Implemented Interfaces:

Serializable, PSEntity

public final class PSDocument
extends PSURI
implements PSEntity

Represents a PageSeeder document. A document is a URI which can have some content and can be typed.

Version:

0.1.0

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
PSDocument(String url) Construct a new document from the specified URL.
PSDocument(String scheme, String host, int port, String path) Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
EntityValidity	checkValid() Known constraints on Member are based on SQL definition:
String	getFilename()
static String	getFilename(String url) Returns the filename from the path or URL.
static String	getFolder(String url) Returns the folder path from the path or URL.
String	getFolderURL()
String	getType()
boolean	isValid() Determines whether the entity is valid based on known PageSeeder constraints.
void	setFilename(String filename)
void	setType(String type)
String	toString()

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

checkURIValid, getCreatedDate, getDescription, getDisplayTitle, getDocid, getId, getIdentifier, getKey, getLabels, getLabelsAsString, getMediaType, getModifiedDate, getTitle, isIdentifiable, setCreatedDate, setDescription, setDocid, setId, setLabels, setLabels, setMediaType, setModifiedDate, setTitle

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, wait, wait, wait

Methods inherited from interface org.pageseeder.bridge.PSEntity

getId, getIdentifier, getKey, isIdentifiable

Constructor Detail

PSDocument

public PSDocument(String url)

Construct a new document 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 to the document.

Throws:

IllegalArgumentException - If the specified URL is invalid

PSDocument

public PSDocument(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.

Method Detail

getFilename

public String getFilename()

Returns:

the filename

getFolderURL

public String getFolderURL()

Returns:

the filename

getType

public String getType()

Returns:

the type

setFilename

public void setFilename(String filename)

Parameters:

filename - the filename to set

setType

public void setType(String type)

Parameters:

type - the type to set

checkValid

public EntityValidity checkValid()

Known constraints on Member are based on SQL definition:

  DocID VARCHAR(100) NULL,
  Scheme VARCHAR(20) CHARACTER SET ascii NULL,
  Path VARCHAR(500) CHARACTER SET ascii NULL,
  HostID INTEGER NULL,
  Port INTEGER NULL,
  Title VARCHAR(250) NULL,
  Behavior VARCHAR(80) NULL,
  LastModified DATETIME NULL,
  Description TEXT NULL,
  UserTitle VARCHAR(250) NULL,
  Type VARCHAR(100) NULL,
  Status VARCHAR(40) NULL,
  Labels VARCHAR(250) NULL,
 

Determines whether this object is valid based on known PageSeeder constraints.

Specified by:

checkValid in interface PSEntity

Returns:

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

isValid

public boolean isValid()

Description copied from interface: PSEntity

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

Specified by:

isValid in interface PSEntity

Overrides:

isValid in class PSURI

Returns:

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

toString

public String toString()

Overrides:

toString in class Object

getFilename

public static String getFilename(String url)

Returns the filename from the path or URL.

Parameters:

url - The path or URL

Returns:

the text after the last '/' in the path or URL

getFolder

public static String getFolder(String url)

Returns the folder path from the path or URL.

Parameters:

url - The path or URL

Returns:

the text before the last '/' in the path or URL