This project has retired. For details please refer to its Attic page.

org.apache.lenya.cms.publication
Class XlinkCollection

java.lang.Object
  org.apache.lenya.cms.publication.DefaultDocument
      org.apache.lenya.cms.publication.CollectionImpl
          org.apache.lenya.cms.publication.XlinkCollection

All Implemented Interfaces:

Collection, Document

public class XlinkCollection
extends CollectionImpl

Implementation of a Collection. In the collection are xlink inserted.

Version:

$Id: XlinkCollection.java 494707 2007-01-10 04:35:24Z antonio $

Author:

Edith Chevrier , Andreas Hartmann

Field Summary

Fields inherited from interface org.apache.lenya.cms.publication.Collection

ATTRIBUTE_ID, DEFAULT_PREFIX, ELEMENT_COLLECTION, ELEMENT_DOCUMENT, NAMESPACE

Constructor Summary

XlinkCollection(Publication publication, java.lang.String id, java.lang.String area)
Ctor.

XlinkCollection(Publication publication, java.lang.String id, java.lang.String area, java.lang.String language)
Ctor.

Method Summary

protected org.w3c.dom.Element	createDocumentElement(Document document, NamespaceHelper helper) (non-Javadoc)
protected NamespaceHelper	getNamespaceHelper() Adds the XLink namespace declaration to the document element.
protected java.lang.String	getXlinkHref(Document document) Returns the href attribute string for a certain document.

Methods inherited from class org.apache.lenya.cms.publication.CollectionImpl

add, add, clear, contains, documents, getDocuments, getFirstPosition, load, loadDocument, remove, save, size

Methods inherited from class org.apache.lenya.cms.publication.DefaultDocument

equals, exists, existsInAnyLanguage, getArea, getCompleteInfoURL, getCompleteURL, getCompleteURLWithoutLanguage, getDocumentURL, getDublinCore, getExtension, getFile, getId, getLabel, getLanguage, getLanguages, getLastModified, getName, getNodeId, getPublication, hashCode, setArea, setDocumentURL, setExtension, setLanguage, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.lenya.cms.publication.Document

exists, existsInAnyLanguage, getArea, getCompleteInfoURL, getCompleteURL, getCompleteURLWithoutLanguage, getDocumentURL, getDublinCore, getExtension, getFile, getId, getLabel, getLanguage, getLanguages, getLastModified, getName, getNodeId, getPublication

Constructor Detail

XlinkCollection

public XlinkCollection(Publication publication,
                       java.lang.String id,
                       java.lang.String area)
                throws DocumentException

Ctor.

Parameters:

publication - A publication.

id - The document ID.

area - The area the document belongs to.

Throws:

DocumentException - when something went wrong.

XlinkCollection

public XlinkCollection(Publication publication,
                       java.lang.String id,
                       java.lang.String area,
                       java.lang.String language)
                throws DocumentException

Ctor.

Parameters:

publication - A publication.

id - The document ID.

area - The area the document belongs to.

language - The language of the document.

Throws:

DocumentException - when something went wrong.

Method Detail

createDocumentElement

protected org.w3c.dom.Element createDocumentElement(Document document,
                                                    NamespaceHelper helper)
                                             throws DocumentException

(non-Javadoc)

Overrides:

createDocumentElement in class CollectionImpl

Parameters:

document - The document.

helper - The namespace helper of the document.

Returns:

An XML element.

Throws:

DocumentException - when something went wrong.

See Also:

CollectionImpl.createDocumentElement(org.apache.lenya.cms.publication.Document, org.apache.lenya.xml.NamespaceHelper)

getXlinkHref

protected java.lang.String getXlinkHref(Document document)
                                 throws DocumentException

Returns the href attribute string for a certain document.

Parameters:

document - The document.

Returns:

A string.

Throws:

DocumentException - when something went wrong.

getNamespaceHelper

protected NamespaceHelper getNamespaceHelper()
                                      throws DocumentException,
                                             javax.xml.parsers.ParserConfigurationException,
                                             org.xml.sax.SAXException,
                                             java.io.IOException

Adds the XLink namespace declaration to the document element.

Overrides:

getNamespaceHelper in class CollectionImpl

Returns:

A namespace helper.

Throws:

DocumentException - when something went wrong.

javax.xml.parsers.ParserConfigurationException - when something went wrong.

org.xml.sax.SAXException - when something went wrong.

java.io.IOException - when something went wrong.

See Also:

CollectionImpl.getNamespaceHelper()