de.smartics.properties.api.core.domain
Class ProjectdocMetaData

java.lang.Object
  de.smartics.properties.api.core.domain.ProjectdocMetaData

All Implemented Interfaces:

DocumentMetaData, Serializable

Direct Known Subclasses:

PropertyProjectdoc, PropertySetProjectdoc

public class ProjectdocMetaData
     
     

      
      extends 
      
      Object
     
     
     
     

      
      implements 
      
      DocumentMetaData
     
     

Stores document instance information for projectdoc metadata.

See Also:

Serialized Form

Constructor Summary

ProjectdocMetaData()
Convenience constructor without a parent to inherit from.

ProjectdocMetaData(ProjectdocMetaData parent)
Default constructor.

Method Summary

void	addAudience(String member) Adds the member to the intended audience of this document.
void	addCategory(String category) Adds a category.
protected static void	addElement(List<String> elements, String element) Adds the element to the given list, if the element is neither blank nor already part of the list.
void	addNote(String note) Adds a note.
void	addParent(String parent) Adds a parent.
void	addTag(String tag) Adds a tag.
List<String>	getAudience() Returns the audience the documentation targets.
List<String>	getCategories() Returns the categories associated with the document instance.
String	getName() Returns the unique document identifier.
List<String>	getNotes() Returns the list of notes appended to the document instance.
ProjectdocMetaData	getParent() Returns the reference to the parent meta data to access as default values.
List<String>	getParents() Returns the parents associated with the document instance.
String	getShortDescription() Returns the short description of the document to be incorporated in an overview table.
String	getSortKey() Returns the value for sortKey.
String	getSpace() Returns the space within which the title of a document is required to be unique.
String	getSummary() Returns the short summary of contents of the document to give more detailed information to a potential reader.
List<String>	getTags() Returns the tags associated with the document instance.
String	getTitle() Returns the title of a document, unique within the given space.
void	setName(String name) Sets the name of the document if not blank.
void	setShortDescription(String shortDescription) Sets the short description of the document to be incorporated in an overview table.
void	setSortKey(String sortKey) Sets the option to sort elements.
void	setSpace(String space) Sets the space within which the title of a document is required to be unique.
void	setSummary(String summary) Sets the short summary of contents of the document to give more detailed information to a potential reader.
void	setTitle(String title) Sets the title of a document, unique within the given space.
String	toString() Returns the string representation of the object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ProjectdocMetaData

public ProjectdocMetaData()

Convenience constructor without a parent to inherit from.

ProjectdocMetaData

public ProjectdocMetaData(ProjectdocMetaData parent)

Default constructor.

Parameters:

parent - the reference to the parent meta data to access as default values.

Method Detail

getParent

public final ProjectdocMetaData getParent()

Returns the reference to the parent meta data to access as default values.

Returns:

the reference to the parent meta data to access as default values.

getCategories

public final List<String> getCategories()

Description copied from interface: DocumentMetaData

Returns the categories associated with the document instance.

Specified by:

getCategories in interface DocumentMetaData

Returns:

the categories associated with the document instance.

addCategory

public final void addCategory(String category)

Adds a category. Blank category names or categories already part of the list will be ignored.

Parameters:

category - the category to be added.

getTags

public final List<String> getTags()

Description copied from interface: DocumentMetaData

Returns the tags associated with the document instance.

Specified by:

getTags in interface DocumentMetaData

Returns:

the tags associated with the document instance.

addTag

public final void addTag(String tag)

Adds a tag. Blank tag names or tags already part of the list will be ignored.

Parameters:

tag - the tag to be added.

getParents

public final List<String> getParents()

Description copied from interface: DocumentMetaData

Returns the parents associated with the document instance.

Specified by:

getParents in interface DocumentMetaData

Returns:

the parents associated with the document instance.

addParent

public final void addParent(String parent)

Adds a parent. Blank parent names or parents already part of the list will be ignored.

Parameters:

parent - the parent to be added.

getName

public final String getName()

Description copied from interface: DocumentMetaData

Returns the unique document identifier. It is generated by the system if not given explicitly.

Dependent on the evaluation context the name given here may be expanded to be unique. So the uniqueness of this key is dependent of the context.

Specified by:

getName in interface DocumentMetaData

Returns:

the unique document identifier.

setName

public final void setName(String name)

Sets the name of the document if not blank.

Parameters:

name - the name of the document to set.

getShortDescription

public final String getShortDescription()

Description copied from interface: DocumentMetaData

Returns the short description of the document to be incorporated in an overview table. Should not exceed one to three sentences.

Specified by:

getShortDescription in interface DocumentMetaData

Returns:

the short description of the document to be incorporated in an overview table.

setShortDescription

public final void setShortDescription(String shortDescription)

Sets the short description of the document to be incorporated in an overview table. Should not exceed one to three sentences. If the value is blank, it is ignored.

Parameters:

shortDescription - the short description of the document to be incorporated in an overview table.

getNotes

public final List<String> getNotes()

Description copied from interface: DocumentMetaData

Returns the list of notes appended to the document instance.

Specified by:

getNotes in interface DocumentMetaData

Returns:

the list of notes appended to the document instance.

addNote

public final void addNote(String note)

Adds a note. Blank notes or notes already part of the list will be ignored.

Parameters:

note - the note to be added.

getSpace

public final String getSpace()

Description copied from interface: DocumentMetaData

Returns the space within which the title of a document is required to be unique.

Specified by:

getSpace in interface DocumentMetaData

Returns:

the space within which the title of a document is required to be unique.

setSpace

public final void setSpace(String space)

Sets the space within which the title of a document is required to be unique. If the value is blank it is ignored.

Parameters:

space - the space within which the title of a document is required to be unique.

getTitle

public final String getTitle()

Description copied from interface: DocumentMetaData

Returns the title of a document, unique within the given space.

Specified by:

getTitle in interface DocumentMetaData

Returns:

the title of a document, unique within the given space.

setTitle

public final void setTitle(String title)

Sets the title of a document, unique within the given space. If the value is blank it is ignored.

Parameters:

title - the title of a document, unique within the given space.

getSummary

public final String getSummary()

Description copied from interface: DocumentMetaData

Returns the short summary of contents of the document to give more detailed information to a potential reader. Should not exceed one too three paragraphs.

Specified by:

getSummary in interface DocumentMetaData

Returns:

the short summary of contents of the document to give more detailed information to a potential reader.

setSummary

public final void setSummary(String summary)

Sets the short summary of contents of the document to give more detailed information to a potential reader. Should not exceed one too three paragraphs. If the value is blank it is ignored.

Parameters:

summary - the short summary of contents of the document to give more detailed information to a potential reader.

getSortKey

public final String getSortKey()

Description copied from interface: DocumentMetaData

Returns the value for sortKey.

Option to sort elements. This sort key is used first for sorting the document instances in the index document of this doctype.

Specified by:

getSortKey in interface DocumentMetaData

Returns:

the value for sortKey.

setSortKey

public final void setSortKey(String sortKey)

Sets the option to sort elements. This sort key is used first for sorting the document instances in the index document of this doctype. If the value is blank it is ignored.

Parameters:

sortKey - the option to sort elements.

getAudience

public final List<String> getAudience()

Description copied from interface: DocumentMetaData

Returns the audience the documentation targets.

Specified by:

getAudience in interface DocumentMetaData

Returns:

the audience the documentation targets.

addAudience

public final void addAudience(String member)

Adds the member to the intended audience of this document.

Parameters:

member - the audience member to add.

addElement

protected static final void addElement(List<String> elements,
                                       String element)

Adds the element to the given list, if the element is neither blank nor already part of the list.

Parameters:

elements - the list to add to.

element - the element to be added.

toString

public final String toString()

Returns the string representation of the object.

Overrides:

toString in class Object

Returns:

the string representation of the object.