de.smartics.properties.report.data
Class PropertyReportItem

java.lang.Object
  de.smartics.properties.report.data.PropertyReportItem

public final class PropertyReportItem
     
     

      
      extends 
      
      Object
     
     

Report information for a particular property.

Nested Class Summary

static class

PropertyReportItem.Builder Builder to create instances of enclosing class.

Method Summary

PropertyComment	getComment() Returns the Javadoc comment to the descriptor.
String	getCommentText() Returns the property comment.
PropertyDescriptor	getDescriptor() Returns the descriptor to the property.
String	getLocalName() Returns the name that uniquely identifies the property report within the report set.
DocumentMetaData	getMetaData() Returns the document instance metadata.
String	getName() Returns the name that uniquely identifies the property report document.
String	getPropertySet() Returns the set of properties this property belongs to.
SourceInfo	getSourceInfo() Returns the information about the source the property was defined in.
String	getSpace() Returns the space the report item belongs to.
String	getTitle() Returns the unique title of the report within the space.
Object	getValue() Returns the optional value in case this is a runtime report.
PropertyValueComment	getValueComment() Returns the property value comment.
void	setValue(Object value) Sets the optional value in case this is a runtime report.

Methods inherited from class java.lang.Object

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

Method Detail

getDescriptor

public PropertyDescriptor getDescriptor()

Returns the descriptor to the property.

Returns:

the descriptor to the property.

getComment

public PropertyComment getComment()

Returns the Javadoc comment to the descriptor.

Returns:

the Javadoc comment to the descriptor.

getCommentText

public String getCommentText()

Returns the property comment.

If the comment is null, this method returns safely null.

Returns:

the property comment.

getValueComment

public PropertyValueComment getValueComment()

Returns the property value comment.

If the comment is null, this method returns safely null.

Returns:

the property value comment.

getSourceInfo

public SourceInfo getSourceInfo()

Returns the information about the source the property was defined in.

Returns:

the information about the source the property was defined in.

getMetaData

public DocumentMetaData getMetaData()

Returns the document instance metadata.

Returns:

the document instance metadata.

getValue

public Object getValue()

Returns the optional value in case this is a runtime report.

Returns:

the optional value in case this is a runtime report.

setValue

public void setValue(Object value)

Sets the optional value in case this is a runtime report.

Parameters:

value - the optional value in case this is a runtime report.

getLocalName

public String getLocalName()

Returns the name that uniquely identifies the property report within the report set.

Returns:

the name that uniquely identifies the property report within the report set.

getName

public String getName()

Returns the name that uniquely identifies the property report document.

Returns:

the name that uniquely identifies the property report document.

getSpace

public String getSpace()

Returns the space the report item belongs to.

Returns:

the space the report item belongs to.

getTitle

public String getTitle()

Returns the unique title of the report within the space.

Returns:

the unique title of the report within the space.

getPropertySet

public String getPropertySet()

Returns the set of properties this property belongs to.

Returns:

the set of properties this property belongs to.