org.outerj.daisy.repository.schema
Interface PartType

All Superinterfaces:

DescriptionEnabled, LabelEnabled

public interface PartType
extends DescriptionEnabled, LabelEnabled

Describes a type of part in the repository.

Instances are retrieved from RepositorySchema.

The equals method for PartType is supported, two part types are equal if all their defining data is equal, with exception of the ID.

Method Summary

long	getId()
Date	getLastModified() When was this PartType last changed (persistently).
long	getLastModifier() Who (which user) last changed this PartType (persistently).
String	getLinkExtractor() Returns the name of the link extractor to use for parts of this type, can be null.
String	getMimeTypes() Returns a string describing limitations on the allowed mime-types.
String	getName()
long	getUpdateCount()
org.outerx.daisy.x10.PartTypeDocument	getXml()
boolean	isDaisyHtml() Indicates if the content of the part is Daisy HTML (well-formed XML using HTML elements).
boolean	isDeprecated()
boolean	mimeTypeAllowed(String mimeType)
void	save()
void	setAllFromXml(org.outerx.daisy.x10.PartTypeDocument.PartType partTypeXml) Changes the state of this object to match the given XML.
void	setDaisyHtml(boolean daisyHtml) Sets the Daisy-HTML flag.
void	setDeprecated(boolean deprecated)
void	setLinkExtractor(String name)
void	setMimeTypes(String mimeTypes) Specify the type of data that is allowed in parts of this type based on the mime-type.
void	setName(String name)

Methods inherited from interface org.outerj.daisy.repository.schema.DescriptionEnabled

clearDescriptions, getDescription, getDescriptionExact, getDescriptionLocales, setDescription

Methods inherited from interface org.outerj.daisy.repository.schema.LabelEnabled

clearLabels, getLabel, getLabelExact, getLabelLocales, setLabel

Method Detail

getId

long getId()

getName

String getName()

setName

void setName(String name)

getMimeTypes

String getMimeTypes()

Returns a string describing limitations on the allowed mime-types. An empty string means no restrictions. Otherwise, the string contains a comma-separated list of allowed mime-types.

setMimeTypes

void setMimeTypes(String mimeTypes)

Specify the type of data that is allowed in parts of this type based on the mime-type.

Parameters:

mimeTypes - A comma-separated list of mime-types. If empty, all mime-types are allowed.

mimeTypeAllowed

boolean mimeTypeAllowed(String mimeType)

isDaisyHtml

boolean isDaisyHtml()

Indicates if the content of the part is Daisy HTML (well-formed XML using HTML elements).

setDaisyHtml

void setDaisyHtml(boolean daisyHtml)

Sets the Daisy-HTML flag.

Note: when the argument daisyHTML is true, the link extractor will be forced to "daisy-html", for reasons of back-compatibility (in the past, link extractors were not explicitely configurable, and link extraction always happened for daisy-html parts). It is possible to override this again by calling setLinkExtractor after setDaisyHtml.

setLinkExtractor

void setLinkExtractor(String name)

Parameters:

name - allowed to be null

getLinkExtractor

String getLinkExtractor()

Returns the name of the link extractor to use for parts of this type, can be null.

isDeprecated

boolean isDeprecated()

setDeprecated

void setDeprecated(boolean deprecated)

getLastModified

Date getLastModified()

When was this PartType last changed (persistently). Returns null on newly created PartTypes.

getLastModifier

long getLastModifier()

Who (which user) last changed this PartType (persistently). Returns -1 on newly created PartTypes.

getXml

org.outerx.daisy.x10.PartTypeDocument getXml()

setAllFromXml

void setAllFromXml(org.outerx.daisy.x10.PartTypeDocument.PartType partTypeXml)

Changes the state of this object to match the given XML. Note that this will only change properties otherwise changeable through methods of this interface, and not internal properties like id or lastModified.

save

void save()
          throws RepositoryException

Throws:

RepositoryException

getUpdateCount

long getUpdateCount()