xbean-blueprint/src/main/java/org/apache/xbean/blueprint/generator/DocumentationGenerator.java [31:198]:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
public class DocumentationGenerator implements GeneratorPlugin {
private final File destFile;
private LogFacade log;
public DocumentationGenerator(File destFile) {
this.destFile = destFile;
}
public void generate(NamespaceMapping namespaceMapping) throws IOException {
String namespace = namespaceMapping.getNamespace();
// TODO can only handle 1 schema document so far...
File file = new File(destFile.getParentFile(), destFile.getName() + ".html");
log.log("Generating HTML documentation file: " + file + " for namespace: " + namespace);
PrintWriter out = new PrintWriter(new FileWriter(file));
try {
generateDocumentation(out, namespaceMapping);
} finally {
out.close();
}
}
private void generateDocumentation(PrintWriter out, NamespaceMapping namespaceMapping) {
String namespace = namespaceMapping.getNamespace();
out.println("");
out.println("");
out.println("");
out.println("Schema for namespace: " + namespace + "");
out.println("");
out.println("");
out.println("");
out.println("");
out.println();
out.println("");
out.println();
generateRootElement(out, namespaceMapping);
generateElementsSummary(out, namespaceMapping);
out.println();
out.println();
generateElementsDetail(out, namespaceMapping);
out.println();
out.println("");
out.println("");
}
private void generateRootElement(PrintWriter out, NamespaceMapping namespaceMapping) {
ElementMapping rootElement = namespaceMapping.getRootElement();
if (rootElement != null) {
out.println("Root Element
");
out.println("");
out.println(" | Element | Description | Class | ");
generateElementSummary(out, rootElement);
out.println("
|---|
");
out.println();
}
}
private void generateElementsSummary(PrintWriter out, NamespaceMapping namespaceMapping) {
out.println("Element Summary
");
out.println("");
out.println(" | Element | Description | Class | ");
for (Iterator iter = namespaceMapping.getElements().iterator(); iter.hasNext();) {
ElementMapping element = (ElementMapping) iter.next();
generateElementSummary(out, element);
}
out.println("
|---|
");
}
private void generateElementSummary(PrintWriter out, ElementMapping element) {
out.println(" " +
"| " + element.getElementName() + " | " +
"" + element.getDescription() + " | " +
"" + element.getClassName() + " |
");
}
private void generateElementsDetail(PrintWriter out, NamespaceMapping namespaceMapping) {
out.println("Element Detail
");
for (Iterator iter = namespaceMapping.getElements().iterator(); iter.hasNext();) {
ElementMapping element = (ElementMapping) iter.next();
generateHtmlElementDetail(out, namespaceMapping, element);
}
}
private void generateHtmlElementDetail(PrintWriter out, NamespaceMapping namespaceMapping, ElementMapping element) {
out.println("");
boolean hasAttributes = false;
boolean hasElements = false;
for (Iterator iterator = element.getAttributes().iterator(); iterator.hasNext() && (!hasAttributes || !hasElements);) {
AttributeMapping attributeMapping = (AttributeMapping) iterator.next();
Type type = attributeMapping.getType();
if (namespaceMapping.isSimpleType(type)) {
hasAttributes = true;
} else {
hasElements = true;
}
}
if (hasAttributes) {
out.println("");
out.println(" | Attribute | Type | Description | ");
for (Iterator iterator = element.getAttributes().iterator(); iterator.hasNext();) {
AttributeMapping attributeMapping = (AttributeMapping) iterator.next();
Type type = attributeMapping.getPropertyEditor() != null ? Type.newSimpleType(String.class.getName()) : attributeMapping.getType();
if (namespaceMapping.isSimpleType(type)) {
out.println("
|---|
| " + attributeMapping.getAttributeName() + " | " + Utils.getXsdType(type)
+ " | " + attributeMapping.getDescription() + " |
");
}
}
out.println("
");
}
if (hasElements) {
out.println("");
out.println(" | Element | Type | Description | ");
for (Iterator iterator = element.getAttributes().iterator(); iterator.hasNext();) {
AttributeMapping attributeMapping = (AttributeMapping) iterator.next();
Type type = attributeMapping.getType();
if (!namespaceMapping.isSimpleType(type)) {
out.print("
|---|
| " + attributeMapping.getAttributeName() + " | ");
printComplexPropertyTypeDocumentation(out, namespaceMapping, type);
out.println(" | " + attributeMapping.getDescription() + " |
");
}
}
out.println("
");
}
}
private void printComplexPropertyTypeDocumentation(PrintWriter out, NamespaceMapping namespaceMapping, Type type) {
if (type.isCollection()) {
out.print("(");
}
List types;
if (type.isCollection()) {
types = Utils.findImplementationsOf(namespaceMapping, type.getNestedType());
} else {
types = Utils.findImplementationsOf(namespaceMapping, type);
}
for (Iterator iterator = types.iterator(); iterator.hasNext();) {
ElementMapping element = (ElementMapping) iterator.next();
out.print("" + element.getElementName() + "");
if (iterator.hasNext()) {
out.print(" | ");
}
}
if (types.size() == 0) {
out.print("<spring:bean/>");
}
if (type.isCollection()) {
out.print(")*");
}
}
public LogFacade getLog() {
return log;
}
public void setLog(LogFacade log) {
this.log = log;
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
xbean-spring/src/main/java/org/apache/xbean/spring/generator/DocumentationGenerator.java [31:198]:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
public class DocumentationGenerator implements GeneratorPlugin {
private final File destFile;
private LogFacade log;
public DocumentationGenerator(File destFile) {
this.destFile = destFile;
}
public void generate(NamespaceMapping namespaceMapping) throws IOException {
String namespace = namespaceMapping.getNamespace();
// TODO can only handle 1 schema document so far...
File file = new File(destFile.getParentFile(), destFile.getName() + ".html");
log.log("Generating HTML documentation file: " + file + " for namespace: " + namespace);
PrintWriter out = new PrintWriter(new FileWriter(file));
try {
generateDocumentation(out, namespaceMapping);
} finally {
out.close();
}
}
private void generateDocumentation(PrintWriter out, NamespaceMapping namespaceMapping) {
String namespace = namespaceMapping.getNamespace();
out.println("");
out.println("");
out.println("");
out.println("Schema for namespace: " + namespace + "");
out.println("");
out.println("");
out.println("");
out.println("");
out.println();
out.println("");
out.println();
generateRootElement(out, namespaceMapping);
generateElementsSummary(out, namespaceMapping);
out.println();
out.println();
generateElementsDetail(out, namespaceMapping);
out.println();
out.println("");
out.println("");
}
private void generateRootElement(PrintWriter out, NamespaceMapping namespaceMapping) {
ElementMapping rootElement = namespaceMapping.getRootElement();
if (rootElement != null) {
out.println("Root Element
");
out.println("");
out.println(" | Element | Description | Class | ");
generateElementSummary(out, rootElement);
out.println("
|---|
");
out.println();
}
}
private void generateElementsSummary(PrintWriter out, NamespaceMapping namespaceMapping) {
out.println("Element Summary
");
out.println("");
out.println(" | Element | Description | Class | ");
for (Iterator iter = namespaceMapping.getElements().iterator(); iter.hasNext();) {
ElementMapping element = (ElementMapping) iter.next();
generateElementSummary(out, element);
}
out.println("
|---|
");
}
private void generateElementSummary(PrintWriter out, ElementMapping element) {
out.println(" " +
"| " + element.getElementName() + " | " +
"" + element.getDescription() + " | " +
"" + element.getClassName() + " |
");
}
private void generateElementsDetail(PrintWriter out, NamespaceMapping namespaceMapping) {
out.println("Element Detail
");
for (Iterator iter = namespaceMapping.getElements().iterator(); iter.hasNext();) {
ElementMapping element = (ElementMapping) iter.next();
generateHtmlElementDetail(out, namespaceMapping, element);
}
}
private void generateHtmlElementDetail(PrintWriter out, NamespaceMapping namespaceMapping, ElementMapping element) {
out.println("");
boolean hasAttributes = false;
boolean hasElements = false;
for (Iterator iterator = element.getAttributes().iterator(); iterator.hasNext() && (!hasAttributes || !hasElements);) {
AttributeMapping attributeMapping = (AttributeMapping) iterator.next();
Type type = attributeMapping.getType();
if (namespaceMapping.isSimpleType(type)) {
hasAttributes = true;
} else {
hasElements = true;
}
}
if (hasAttributes) {
out.println("");
out.println(" | Attribute | Type | Description | ");
for (Iterator iterator = element.getAttributes().iterator(); iterator.hasNext();) {
AttributeMapping attributeMapping = (AttributeMapping) iterator.next();
Type type = attributeMapping.getPropertyEditor() != null ? Type.newSimpleType(String.class.getName()) : attributeMapping.getType();
if (namespaceMapping.isSimpleType(type)) {
out.println("
|---|
| " + attributeMapping.getAttributeName() + " | " + Utils.getXsdType(type)
+ " | " + attributeMapping.getDescription() + " |
");
}
}
out.println("
");
}
if (hasElements) {
out.println("");
out.println(" | Element | Type | Description | ");
for (Iterator iterator = element.getAttributes().iterator(); iterator.hasNext();) {
AttributeMapping attributeMapping = (AttributeMapping) iterator.next();
Type type = attributeMapping.getType();
if (!namespaceMapping.isSimpleType(type)) {
out.print("
|---|
| " + attributeMapping.getAttributeName() + " | ");
printComplexPropertyTypeDocumentation(out, namespaceMapping, type);
out.println(" | " + attributeMapping.getDescription() + " |
");
}
}
out.println("
");
}
}
private void printComplexPropertyTypeDocumentation(PrintWriter out, NamespaceMapping namespaceMapping, Type type) {
if (type.isCollection()) {
out.print("(");
}
List types;
if (type.isCollection()) {
types = Utils.findImplementationsOf(namespaceMapping, type.getNestedType());
} else {
types = Utils.findImplementationsOf(namespaceMapping, type);
}
for (Iterator iterator = types.iterator(); iterator.hasNext();) {
ElementMapping element = (ElementMapping) iterator.next();
out.print("" + element.getElementName() + "");
if (iterator.hasNext()) {
out.print(" | ");
}
}
if (types.size() == 0) {
out.print("<spring:bean/>");
}
if (type.isCollection()) {
out.print(")*");
}
}
public LogFacade getLog() {
return log;
}
public void setLog(LogFacade log) {
this.log = log;
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -