org.pageseeder.bridge.model

Class PSFolder

java.lang.Object

org.pageseeder.bridge.model.PSAddressable

org.pageseeder.bridge.model.PSURI

org.pageseeder.bridge.model.PSFolder

All Implemented Interfaces:

Serializable, PSEntity

public final class PSFolder
extends PSURI
implements PSEntity

Represents a PageSeeder folder. A folder is a URI which acts as a container for other folders and documents.

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
PSFolder(String url) Construct a new folder from the specified URL.

Method Summary

Methods

Modifier and Type	Method and Description
EntityValidity	checkValid() Known constraints on Member are based on SQL definition:
String	getFoldername()
static String	getFoldername(String url) Returns the foldername from the path or URL.
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, isValid, 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, isValid

Constructor Detail

PSFolder

public PSFolder(String url)

Construct a new folder 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 of the folder.

Throws:

IllegalArgumentException - If the specified URL is invalid

Method Detail

getFoldername

public String getFoldername()

Returns:

the foldername

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.

toString

public String toString()

Overrides:

toString in class Object

getFoldername

public static String getFoldername(String url)

Returns the foldername from the path or URL.

Parameters:

url - The path or URL

Returns:

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