org.apache.lenya.cms.publication
Interface ResourceType

public interface ResourceType

Version:

$Id:$

Nested Class Summary

static class

ResourceType.Sample A resource type sample.

Field Summary

static java.lang.String	I18N_PREFIX Prefix for translating the resource type name, e.g.
static java.lang.String	ROLE The Avalon service role.

Method Summary

java.util.Date	getExpires() Returns the date at which point the requested resource is considered expired
java.lang.String[]	getFormats()
java.lang.String	getFormatURI(java.lang.String format)
java.lang.String[]	getLinkAttributeXPaths() Returns an array of XPaths representing attributes to be rewritten when a document URL has changed.
java.lang.String	getName() Returns the name of this document type.
ResourceType.Sample	getSample(java.lang.String name)
java.lang.String[]	getSampleNames()
Schema	getSchema()
void	setName(java.lang.String name)

Field Detail

ROLE

static final java.lang.String ROLE

The Avalon service role.

I18N_PREFIX

static final java.lang.String I18N_PREFIX

Prefix for translating the resource type name, e.g. <i18n:text>resourceType-<jx:out value="${resourceType.getName()}"/></i18n:text>

See Also:

Constant Field Values

Method Detail

getExpires

java.util.Date getExpires()

Returns the date at which point the requested resource is considered expired

Returns:

a string in RFC 1123 date format

getName

java.lang.String getName()

Returns the name of this document type.

Returns:

A string value.

getSchema

Schema getSchema()

Returns:

The source URI of the RelaxNG schema.

getLinkAttributeXPaths

java.lang.String[] getLinkAttributeXPaths()

Returns an array of XPaths representing attributes to be rewritten when a document URL has changed.

Returns:

An array of strings.

getSampleNames

java.lang.String[] getSampleNames()

Returns:

The names of all available samples. The first one is the default sample.

getSample

ResourceType.Sample getSample(java.lang.String name)

Parameters:

name - The name.

Returns:

The sample with the specified name.

setName

void setName(java.lang.String name)

Parameters:

name - The name of the resource type.

getFormats

java.lang.String[] getFormats()

Returns:

All supported formats.

getFormatURI

java.lang.String getFormatURI(java.lang.String format)

Parameters:

format - The format.

Returns:

The URI to get the formatted content at.