Package org.jfree.xml.generator.model
Class DescriptionModel
java.lang.Object
org.jfree.xml.generator.model.DescriptionModel
A model containing class descriptions.
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds a class description to the model.void
addIncludeComment
(String source, Comments comments) Adds an include comment.void
Adds a source to the model description.get
(int index) Returns a class description.Returns a class description for the given class name.getIncludeComment
(String source) Returns the include comment for the specified source.Returns the mapping model.Returns the model comments.String[]
Returns the sources for the model description.void
prune()
Removes any class descriptions that are not fully defined.void
Removes a class description from the model.void
setModelComments
(Comments modelComments) Sets the model comments.int
size()
Returns the number of classes in the model.
-
Field Details
-
sources
The sources. -
classes
The classes. -
classesMap
Maps classes to class descriptions. -
mappingModel
The mapping model. -
modelComments
Model comments. -
includeComments
Include comments.
-
-
Constructor Details
-
DescriptionModel
public DescriptionModel()Creates a new class description model.
-
-
Method Details
-
addClassDescription
Adds a class description to the model.- Parameters:
cd
- the class description.
-
removeClassDescription
Removes a class description from the model.- Parameters:
cd
- the class description.
-
get
Returns a class description.- Parameters:
index
- the description index (zero-based).- Returns:
- a class description.
-
get
Returns a class description for the given class name.- Parameters:
key
- the class name.- Returns:
- the class description.
-
size
public int size()Returns the number of classes in the model.- Returns:
- the number of classes in the model.
-
getMappingModel
Returns the mapping model.- Returns:
- the mapping model.
-
addSource
Adds a source to the model description.- Parameters:
source
- the source.
-
getSources
Returns the sources for the model description.- Returns:
- The sources.
-
prune
public void prune()Removes any class descriptions that are not fully defined. -
addIncludeComment
Adds an include comment.- Parameters:
source
- the source.comments
- the comments.
-
getIncludeComment
Returns the include comment for the specified source.- Parameters:
source
- the source.- Returns:
- The include comment.
-
getModelComments
Returns the model comments.- Returns:
- The model comments.
-
setModelComments
Sets the model comments.- Parameters:
modelComments
- the model comments.
-