smacs.xngr.browser.document
Interface CategoryProperties

All Known Implementing Classes:

CategoryPropertiesXml

public interface CategoryProperties

The base interface for the category properties. It is derived from the original properties/CategoryProperties which is now an implementation of it.

Author:

Edwin Dankert

Method Summary

void	addCategory(CategoryProperties properties) Adds the category properties.
void	addDocument(DocumentProperties properties) Adds the document properties to the category.
Vector	getCategories() Returns the properties for the child categories.
Vector	getDocuments() Returns the properties for the documents in this category.
Element	getElement() Returns the dom4j Element representation of this category.
String	getName() Returns the name of the category.
CategoryProperties	newCategoryProperties(Element element) Constructor for the category properties.
CategoryProperties	newCategoryProperties(String name) Constructor for the category properties.
void	removeCategory(CategoryProperties properties) Removes a category from the parent property.
void	removeDocument(DocumentProperties properties) Removes a document from the category.
void	setName(String name) Sets the name of the category.

Method Detail

newCategoryProperties

public CategoryProperties newCategoryProperties(Element element)

Constructor for the category properties.

newCategoryProperties

public CategoryProperties newCategoryProperties(String name)

Constructor for the category properties.

Parameters:

name - the name of the category.

getName

public String getName()

Returns the name of the category.

Returns:

the name.

setName

public void setName(String name)

Sets the name of the category.

addCategory

public void addCategory(CategoryProperties properties)

Adds the category properties.

Parameters:

properties - the category properties.

removeCategory

public void removeCategory(CategoryProperties properties)

Removes a category from the parent property.

Parameters:

properties - the category properties.

getCategories

public Vector getCategories()

Returns the properties for the child categories.

Returns:

a list of Category Properties.

addDocument

public void addDocument(DocumentProperties properties)

Adds the document properties to the category.

Parameters:

properties - the document properties.

removeDocument

public void removeDocument(DocumentProperties properties)

Removes a document from the category.

Parameters:

properties - the document properties.

getDocuments

public Vector getDocuments()

Returns the properties for the documents in this category.

Returns:

a list of Document Properties.

getElement

public Element getElement()

Returns the dom4j Element representation of this category.

Returns:

the element.