ff-attic/x4o
2
0
Fork 0
Code Issues 2 Pull requests Activity

Init commit of full project.

Browse source
This commit is contained in:
Willem Cazander 2012-09-11 13:15:26 +02:00
parent 130d471bd9
commit 787b1174b0
286 changed files with 27010 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

23
x4o-elddoc/.project Normal file
View file

@ -0,0 +1,23 @@
<?xml version="1.0" encoding="UTF-8"?>
<projectDescription>
<name>x4o-elddoc</name>
<comment>x4o-elddoc</comment>
<projects>
</projects>
<buildSpec>
<buildCommand>
<name>org.eclipse.jdt.core.javabuilder</name>
<arguments>
</arguments>
</buildCommand>
<buildCommand>
<name>org.eclipse.m2e.core.maven2Builder</name>
<arguments>
</arguments>
</buildCommand>
</buildSpec>
<natures>
<nature>org.eclipse.jdt.core.javanature</nature>
<nature>org.eclipse.m2e.core.maven2Nature</nature>
</natures>
</projectDescription>

52
x4o-elddoc/pom.xml Normal file
View file

@ -0,0 +1,52 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<artifactId>x4o</artifactId>
<groupId>org.x4o</groupId>
<version>0.8.2-SNAPSHOT</version>
</parent>
<artifactId>x4o-elddoc</artifactId>
<packaging>jar</packaging>
<name>x4o-elddoc</name>
<description>x4o-elddoc</description>
<dependencies>
<dependency>
<groupId>org.x4o</groupId>
<artifactId>x4o-core</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>de.odysseus.juel</groupId>
<artifactId>juel</artifactId>
<version>${juel.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>${junit.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.x4o</groupId>
<artifactId>x4o-core</artifactId>
<version>${project.version}</version>
<type>test-jar</type>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<pluginManagement>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-site-plugin</artifactId>
<version>${maven-site-plugin.version}</version>
<configuration>
<siteDirectory>${project.basedir}/../src/site-child</siteDirectory>
</configuration>
</plugin>
</plugins>
</pluginManagement>
</build>
</project>

103
x4o-elddoc/src/main/java/org/x4o/xml/eld/doc/EldDocGenerator.java Normal file
View file

@ -0,0 +1,103 @@
/*
* Copyright (c) 2004-2012, Willem Cazander
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided
* that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright notice, this list of conditions and the
* following disclaimer.
* * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and
* the following disclaimer in the documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
* THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
* OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
* TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.x4o.xml.eld.doc;
import java.io.File;
import org.x4o.xml.element.ElementAttributeHandler;
import org.x4o.xml.element.ElementBindingHandler;
import org.x4o.xml.element.ElementClass;
import org.x4o.xml.element.ElementConfigurator;
import org.x4o.xml.element.ElementInterface;
import org.x4o.xml.element.ElementLanguage;
import org.x4o.xml.element.ElementException;
import org.x4o.xml.element.ElementLanguageModule;
import org.x4o.xml.element.ElementNamespaceContext;
/**
* EldDocGenerator writes documentation.
*
* @author Willem Cazander
* @version 1.0 Aug 26, 2010
*/
public class EldDocGenerator {
private ElementLanguage context = null;
public EldDocGenerator(ElementLanguage context) {
this.context=context;
}
public void writeDoc(File basePath) throws ElementException {
EldDocHtmlWriter writer = new EldDocHtmlWriter();
try {
writer.writeIndex(basePath, context);
writer.writeStylesheet(basePath);
writer.writeOverviewModule(basePath, context);
writer.writeOverviewNamespace(basePath, context);
for (ElementLanguageModule mod:context.getElementLanguageModules()) {
writer.writeOverviewModule(basePath, mod);
for (ElementBindingHandler bind:mod.getElementBindingHandlers()) {
writer.writeBindingHandler(basePath,bind,mod);
}
for (ElementAttributeHandler attr:mod.getElementAttributeHandlers()) {
writer.writeAttributeHandler(basePath,attr,mod);
}
for (ElementConfigurator conf:mod.getGlobalElementConfigurators()) {
writer.writeElementConfigurator(basePath,conf,mod);
}
for (ElementInterface iface:mod.getElementInterfaces()) {
writer.writeElementInterface(basePath,iface,mod);
for (ElementBindingHandler bind:iface.getElementBindingHandlers()) {
writer.writeBindingHandler(basePath,bind,mod,iface);
}
//for (ElementAttributeHandler attr:iface.getElementClassAttributes()) {
// writer.writeAttributeHandler(basePath,attr,mod,true);
//}
for (ElementConfigurator conf:iface.getElementConfigurators()) {
writer.writeElementConfigurator(basePath,conf,mod,iface);
}
}
for (ElementNamespaceContext ns:mod.getElementNamespaceContexts()) {
writer.writeOverviewElement(basePath, ns,mod);
for (ElementClass ec:ns.getElementClasses()) {
writer.writeElement(basePath, ec, ns, mod);
for (ElementConfigurator conf:ec.getElementConfigurators()) {
writer.writeElementConfigurator(basePath,conf,mod,ns,ec);
}
}
}
}
} catch (Exception e) {
throw new ElementException(e); // todo rm
}
}
}

676
x4o-elddoc/src/main/java/org/x4o/xml/eld/doc/EldDocHtmlWriter.java Normal file
View file

@ -0,0 +1,676 @@
/*
* Copyright (c) 2004-2012, Willem Cazander
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided
* that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright notice, this list of conditions and the
* following disclaimer.
* * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and
* the following disclaimer in the documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
* THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
* OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
* TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.x4o.xml.eld.doc;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.PrintWriter;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.Date;
import java.util.List;
import org.x4o.xml.element.ElementAttributeHandler;
import org.x4o.xml.element.ElementBindingHandler;
import org.x4o.xml.element.ElementClass;
import org.x4o.xml.element.ElementClassAttribute;
import org.x4o.xml.element.ElementConfigurator;
import org.x4o.xml.element.ElementLanguage;
import org.x4o.xml.element.ElementInterface;
import org.x4o.xml.element.ElementLanguageModule;
import org.x4o.xml.element.ElementNamespaceContext;
/**
* EldDocHtmlWriter writes simple eld documentation.
*
*
*
* @author Willem Cazander
* @version 1.0 Aug 26, 2010
*/
public class EldDocHtmlWriter {
private static final String TAB = "&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;";
private String toSafeUri(String uri) {
StringBuilder buf = new StringBuilder(20);
for (char c:uri.toLowerCase().toCharArray()) {
if (Character.isLetter(c)) {
buf.append(c);
}
if (Character.isDigit(c)) {
buf.append(c);
}
if ('.'==c) {
buf.append(c);
}
if ('-'==c) {
buf.append(c);
}
}
String prefix = buf.toString();
if (prefix.startsWith("http")) {
prefix = prefix.substring(4);
}
if (prefix.startsWith("uri")) {
prefix = prefix.substring(3);
}
if (prefix.startsWith("url")) {
prefix = prefix.substring(3);
}
return prefix;
}
private PrintWriter createPrintWriter(File basePath,String...argu) throws FileNotFoundException {
StringBuffer buf = new StringBuffer(200);
buf.append(basePath.getAbsolutePath());
buf.append(File.separatorChar);
for (int i=0;i<argu.length-1;i++) {
buf.append(toSafeUri(argu[i]));
buf.append(File.separatorChar);
}
File outputPath = new File(buf.toString());
if (outputPath.exists()==false) {
//System.out.println("Creating path: "+outputPath);
outputPath.mkdirs();
}
buf.append(File.separatorChar);
buf.append(toSafeUri(argu[argu.length-1]));
File outputFile = new File(buf.toString());
//System.out.println("Creating file: "+outputFile);
PrintWriter pw = new PrintWriter(outputFile);
return pw;
}
public void writeStylesheet(File basePath) throws IOException {
PrintWriter pw = createPrintWriter(basePath,"stylesheet.css");
try {
pw.write("\n\n");
pw.flush();
pw.print("body { background-color: #FFFFFF; color:#000000 }\n");
pw.print("h1 { font-size: 145% }\n");
pw.print(".TableHeadingColor { background: #CCCCFF; color:#000000 }\n");
pw.print(".TableSubHeadingColor { background: #EEEEFF; color:#000000 }\n");
pw.print(".TableRowColor { background: #FFFFFF; color:#000000 }\n");
pw.print(".FrameTitleFont { font-size: 100%; font-family: Helvetica, Arial, sans-serif; color:#000000 }\n");
pw.print(".FrameHeadingFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 }\n");
pw.print(".FrameItemFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 }\n");
pw.print(".NavBarCell1 { background-color:#EEEEFF; color:#000000}\n");
pw.print(".NavBarCell1Rev { background-color:#00008B; color:#FFFFFF}\n");
pw.print(".NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;color:#000000;}\n");
pw.print(".NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;color:#FFFFFF;}\n");
pw.print(".NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000}\n");
pw.print(".NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000}\n");
pw.flush();
} finally {
if (pw!=null) {
pw.close();
}
}
}
public void writeIndex(File basePath,ElementLanguage context) throws IOException {
PrintWriter pw = createPrintWriter(basePath,"index.html");
try {
String title = context.getLanguageConfiguration().getLanguage()+" "+context.getLanguageConfiguration().getLanguageVersion()+" ELD";
printHeader(pw,"Index ("+title+")","");
printPageIndexTitle(pw,title,null,null);
int attrHandlers = 0;
int bindHandlers = 0;
int interFaces = 0;
int eleConfigs = 0;
int elements = 0;
int namespaces = 0;
for (ElementLanguageModule mod:context.getElementLanguageModules()) {
attrHandlers =+ mod.getElementAttributeHandlers().size();
bindHandlers =+ mod.getElementBindingHandlers().size();
interFaces =+ mod.getElementInterfaces().size();
eleConfigs =+ mod.getGlobalElementConfigurators().size();
for (ElementNamespaceContext ns:mod.getElementNamespaceContexts()) {
namespaces++;
elements =+ ns.getElementClasses().size();
}
}
pw.print("<p>Welcome to the EldDocs</p>");
printTableStart(pw,"Language Stats");
printTableRowSummary(pw,"Language:",""+context.getLanguageConfiguration().getLanguage());
printTableRowSummary(pw,"LanguageVersion:",""+context.getLanguageConfiguration().getLanguageVersion());
printTableRowSummary(pw,"Modules:",""+context.getElementLanguageModules().size());
printTableRowSummary(pw,"Namespaces:",""+namespaces);
printTableRowSummary(pw,"Elements:",""+elements);
printTableRowSummary(pw,"ElementInterfaces:",""+interFaces);
printTableRowSummary(pw,"ElementAttributeHandlers:",""+attrHandlers);
printTableRowSummary(pw,"ElementBindingHandlers:",""+bindHandlers);
printTableRowSummary(pw,"ElementConfigurators:",""+eleConfigs);
printTableEnd(pw);
printBottom(pw,"");
} finally {
if (pw!=null) {
pw.close();
}
}
}
public void writeOverviewModule(File basePath,ElementLanguage context) throws IOException {
PrintWriter pw = createPrintWriter(basePath,"module-overview.html");
try {
String title = context.getLanguageConfiguration().getLanguage()+" "+context.getLanguageConfiguration().getLanguageVersion()+" ELD";
printHeader(pw,"Overview ("+title+")","");
printPageIndexTitle(pw,title,null,null);
printTableStart(pw,"Modules");
for (ElementLanguageModule mod:context.getElementLanguageModules()) {
printTableRowOverview(pw,toSafeUri(mod.getId())+"/index.html",mod.getId(),mod.getName());
}
printTableEnd(pw);
printBottom(pw,"");
} finally {
if (pw!=null) {
pw.close();
}
}
}
public void writeOverviewNamespace(File basePath,ElementLanguage context) throws IOException {
PrintWriter pw = createPrintWriter(basePath,"namespace-overview.html");
String pathPrefix = "";
try {
String title = context.getLanguageConfiguration().getLanguage()+" "+context.getLanguageConfiguration().getLanguageVersion()+" ELD";
printHeader(pw,"Overview ("+title+")",pathPrefix);
printPageIndexTitle(pw,title,null,null);
for (ElementLanguageModule mod:context.getElementLanguageModules()) {
printNamespaces(pw,mod.getElementNamespaceContexts(),pathPrefix,mod);
}
printBottom(pw,pathPrefix);
} finally {
if (pw!=null) {
pw.close();
}
}
}
public void writeOverviewModule(File basePath,ElementLanguageModule mod) throws IOException {
PrintWriter pw = createPrintWriter(basePath,mod.getId(),"index.html");
String pathPrefix = "../";
try {
printHeader(pw,"Overview ("+mod.getId()+")",pathPrefix);
printPageTitle(pw,"Module",mod.getName(),mod.getDescription());
String pathPrefixModule = pathPrefix+toSafeUri(mod.getId())+"/";
printElementInterfaces(pw,mod.getElementInterfaces(),pathPrefixModule);
printAttributeHandlers(pw,mod.getElementAttributeHandlers(),pathPrefixModule);
printBindingHandlers(pw,mod.getElementBindingHandlers(),pathPrefixModule);
printConfigurators(pw, mod.getGlobalElementConfigurators(),pathPrefixModule);
printNamespaces(pw, mod.getElementNamespaceContexts(),pathPrefix,mod);
printBottom(pw,pathPrefix);
} finally {
if (pw!=null) {
pw.close();
}
}
}
public void writeOverviewElement(File basePath,ElementNamespaceContext ns,ElementLanguageModule mod) throws IOException {
PrintWriter pw = createPrintWriter(basePath,mod.getId(),ns.getId(),"index.html");
String pathPrefix = "../../";
try {
String title = ns.getUri();
printHeader(pw,"Overview ("+title+")",pathPrefix);
printPageTitle(pw,"Namespace",ns.getUri(),ns.getDescription());
printTableStart(pw,"Element Summary");
for (ElementClass ec:ns.getElementClasses()) {
printTableRowOverview(pw,toSafeUri(ec.getTag())+"/index.html",ec.getTag(),ec.getDescription());
}
printTableEnd(pw);
printBottom(pw,pathPrefix);
} finally {
if (pw!=null) {
pw.close();
}
}
}
public void writeElement(File basePath,ElementClass ec,ElementNamespaceContext ns,ElementLanguageModule mod) throws IOException {
PrintWriter pw = createPrintWriter(basePath,mod.getId(),ns.getId(),ec.getTag(),"index.html");
String pathPrefix = "../../../";
try {
printHeader(pw,"Tag ("+ec.getTag()+")",pathPrefix);
printPageTitle(pw,"Tag",ec.getTag(),ec.getDescription());
printTableStart(pw,"Element Properties");
printTableRowSummary(pw,"objectClass",""+ec.getObjectClass());
printTableRowSummary(pw,"elementClass",""+ec.getElementClass());
printTableRowSummary(pw,"autoAttributes",""+ec.getAutoAttributes());
printTableRowSummary(pw,"schemaContentBase",""+ec.getSchemaContentBase());
printTableRowSummary(pw,"schemaContentComplex",""+ec.getSchemaContentComplex());
printTableRowSummary(pw,"schemaContentMixed",""+ec.getSchemaContentMixed());
printTableEnd(pw);
printTableStart(pw,"Element Attributes");
for (ElementClassAttribute attr:ec.getElementClassAttributes()) {
printTableRowSummary(pw,attr.getName(),attr.getDescription());
}
printTableEnd(pw);
if (ec.getObjectClass()!=null) {
printClassProperties(pw, ec.getObjectClass());
}
printConfigurators(pw,ec.getElementConfigurators(),"");
printBottom(pw,pathPrefix);
} finally {
if (pw!=null) {
pw.close();
}
}
}
public void writeElementInterface(File basePath,ElementInterface iface,ElementLanguageModule mod) throws IOException {
PrintWriter pw = createPrintWriter(basePath,mod.getId(),"interface",iface.getId()+".html");
String pathPrefix = "../../";
String pathLocal = toSafeUri(iface.getId())+"/";
try {
printHeader(pw,"ElementInterface ("+iface.getId()+")",pathPrefix);
printPageTitle(pw,"ElementInterface",iface.getId(),iface.getDescription());
printConfigurators(pw,iface.getElementConfigurators(),pathLocal);
printBindingHandlers(pw,iface.getElementBindingHandlers(),pathLocal);
//iface.getElementClassAttributes()
printBeanProperties(pw, iface);
printBottom(pw,pathPrefix);
} finally {
if (pw!=null) {
pw.close();
}
}
}
public void writeElementConfigurator(File basePath,ElementConfigurator conf,ElementLanguageModule mod) throws IOException {
PrintWriter pw = createPrintWriter(basePath,mod.getId(),"conf",conf.getId()+".html");
String pathPrefix = "../../";
try {
printHeader(pw,"Configurator ("+conf.getId()+")",pathPrefix);
printPageTitle(pw,"Configurator",conf.getId(),conf.getDescription());
printBeanProperties(pw, conf);
printBottom(pw,pathPrefix);
} finally {
if (pw!=null) {
pw.close();
}
}
}
public void writeElementConfigurator(File basePath,ElementConfigurator conf,ElementLanguageModule mod,ElementInterface iface) throws IOException {
PrintWriter pw = createPrintWriter(basePath,mod.getId(),"interface",iface.getId(),"conf",conf.getId()+".html");
String pathPrefix = "../../../../";
try {
printHeader(pw,"Interface Configurator ("+conf.getId()+")",pathPrefix);
printPageTitle(pw,"Interface Configurator",conf.getId(),conf.getDescription());
printBeanProperties(pw, conf);
printBottom(pw,pathPrefix);
} finally {
if (pw!=null) {
pw.close();
}
}
}
public void writeElementConfigurator(File basePath,ElementConfigurator conf,ElementLanguageModule mod,ElementNamespaceContext ns,ElementClass ec) throws IOException {
PrintWriter pw = createPrintWriter(basePath,mod.getId(),ns.getId(),ec.getTag(),"conf",conf.getId()+".html");
String pathPrefix = "../../../../";
try {
printHeader(pw,"Interface Configurator ("+conf.getId()+")",pathPrefix);
printPageTitle(pw,"Interface Configurator",conf.getId(),conf.getDescription());
printBeanProperties(pw, conf);
printBottom(pw,pathPrefix);
} finally {
if (pw!=null) {
pw.close();
}
}
}
public void writeBindingHandler(File basePath,ElementBindingHandler bind,ElementLanguageModule mod) throws IOException {
PrintWriter pw = createPrintWriter(basePath,mod.getId(),"bind",bind.getId()+".html");
String pathPrefix = "../../";
try {
printHeader(pw,"BindingHandler ("+bind.getId()+")",pathPrefix);
printPageTitle(pw,"BindingHandler",bind.getId(),bind.getDescription());
printTableStart(pw,"Child Classes");
for (Class<?> clazz:bind.getBindChildClasses()) {
printTableRowSummary(pw,"class",""+clazz.getName());
}
printTableEnd(pw);
printBeanProperties(pw, bind);
printBottom(pw,pathPrefix);
} finally {
if (pw!=null) {
pw.close();
}
}
}
public void writeBindingHandler(File basePath,ElementBindingHandler bind,ElementLanguageModule mod,ElementInterface iface) throws IOException {
PrintWriter pw = createPrintWriter(basePath,mod.getId(),"interface",iface.getId(),"bind",bind.getId()+".html");
String pathPrefix = "../../../../";
try {
printHeader(pw,"Interface BindingHandler ("+bind.getId()+")",pathPrefix);
printPageTitle(pw,"Interface BindingHandler",bind.getId(),bind.getDescription());
printTableStart(pw,"Child Classes");
for (Class<?> clazz:bind.getBindChildClasses()) {
printTableRowSummary(pw,"class",""+clazz.getName());
}
printTableEnd(pw);
printBeanProperties(pw, bind);
printBottom(pw,pathPrefix);
} finally {
if (pw!=null) {
pw.close();
}
}
}
public void writeAttributeHandler(File basePath,ElementAttributeHandler attr,ElementLanguageModule mod) throws IOException {
PrintWriter pw = createPrintWriter(basePath,mod.getId(),"attr",attr.getId()+".html");
String pathPrefix = "../../";
try {
printHeader(pw,"AttributeHandler ("+attr.getId()+")",pathPrefix);
printPageTitle(pw,"AttributeHandler",attr.getId(),attr.getDescription());
printBeanProperties(pw, attr);
printBottom(pw,pathPrefix);
} finally {
if (pw!=null) {
pw.close();
}
}
}
private void printClassProperties(PrintWriter pw,Class<?> beanClass) {
printTableStart(pw,"Class Properties");
for (Method m:beanClass.getMethods()) {
if (m.getName().startsWith("set")) {
String n = m.getName().substring(3);
if (m.getParameterTypes().length==0) {
continue; // set without parameters
}
if (n.length()<2) {
continue;
}
n = n.substring(0,1).toLowerCase()+n.substring(1,n.length());
Class<?> type = m.getParameterTypes()[0]; // TODO make full list for auto attribute type resolving.
printTableRowSummary(pw,n,""+type);
}
}
printTableEnd(pw);
}
private void printBeanProperties(PrintWriter pw,Object bean) {
printTableStart(pw,"Bean Properties");
for (Method m:bean.getClass().getMethods()) {
if (m.getName().startsWith("get")) {
String n = m.getName().substring(3);
if (m.getParameterTypes().length!=0) {
continue; // set without parameters
}
if (n.length()<2) {
continue;
}
n = n.substring(0,1).toLowerCase()+n.substring(1,n.length());
Object value = null;
try {
value = m.invoke(bean, new Object[] {});
} catch (IllegalArgumentException e) {
e.printStackTrace();
} catch (IllegalAccessException e) {
e.printStackTrace();
} catch (InvocationTargetException e) {
e.printStackTrace();
}
printTableRowSummary(pw,n,""+value);
}
}
printTableEnd(pw);
}
private void printNamespaces(PrintWriter pw,List<ElementNamespaceContext> namespaces,String pathPrefix ,ElementLanguageModule mod) {
printTableStart(pw,"Namespaces");
for (ElementNamespaceContext ns:namespaces) {
printTableRowOverview(pw,pathPrefix+toSafeUri(mod.getId())+"/"+toSafeUri(ns.getId())+"/index.html",ns.getId(),"<b>"+ns.getUri()+"</b><br/>"+TAB+ns.getName());
}
printTableEnd(pw);
}
private void printConfigurators(PrintWriter pw,List<ElementConfigurator> confs,String pathPrefix) {
printTableStart(pw,"Configurators");
for (ElementConfigurator conf:confs) {
printTableRowOverview(pw,pathPrefix+"conf/"+toSafeUri(conf.getId())+".html",conf.getId(),conf.getDescription());
}
printTableEnd(pw);
}
private void printBindingHandlers(PrintWriter pw,List<ElementBindingHandler> binds,String pathPrefix) {
printTableStart(pw,"Binding handlers");
for (ElementBindingHandler bind:binds) {
printTableRowOverview(pw,pathPrefix+"bind/"+toSafeUri(bind.getId())+".html",bind.getId(),bind.getDescription());
}
printTableEnd(pw);
}
private void printAttributeHandlers(PrintWriter pw,List<ElementAttributeHandler> attrs,String pathPrefix) {
printTableStart(pw,"Attribute handlers");
for (ElementAttributeHandler attr:attrs) {
printTableRowOverview(pw,pathPrefix+"attr/"+toSafeUri(attr.getId())+".html",attr.getId(),attr.getDescription());
}
printTableEnd(pw);
}
private void printElementInterfaces(PrintWriter pw,List<ElementInterface> ifaces,String pathPrefix) {
printTableStart(pw,"Element Interfaces");
for (ElementInterface iface:ifaces) {
printTableRowOverview(pw,pathPrefix+"interface/"+toSafeUri(iface.getId())+".html",""+iface.getId(),iface.getDescription());
}
printTableEnd(pw);
}
private void printTableStart(PrintWriter pw,String title) {
pw.print("<table border=\"1\" width=\"100%\" cellpadding=\"3\" cellspacing=\"0\" summary=\"\">\n");
pw.print("<tr bgcolor=\"#CCCCFF\" class=\"TableHeadingColor\">\n");
pw.print("<th align=\"left\" colspan=\"2\"><font size=\"+2\">\n");
pw.print("<b>");
pw.print(title);
pw.print("</b>");
pw.print("</font></th>\n</tr>\n");
}
private void printTableRowSummary(PrintWriter pw,String name,String description) {
pw.print("<tr bgcolor=\"white\" class=\"TableRowColor\">\n");
pw.print("<td width=\"20%\">");
pw.print(name);
pw.print("</td>\n");
pw.print("<td>\n");
if (description!=null) {
pw.print(description);
}
pw.print("</td>\n");
pw.print("</tr>\n");
}
private void printTableRowOverview(PrintWriter pw,String href,String hrefTitle,String description) {
pw.print("<tr bgcolor=\"white\" class=\"TableRowColor\">\n");
pw.print("<td width=\"20%\"><b><a href=\"\n");
pw.print(href);
pw.print("\">");
pw.print(hrefTitle);
pw.print("</a></b></td>\n");
pw.print("<td>\n");
if (description!=null) {
pw.print(description);
}
pw.print("</td>\n");
pw.print("</tr>\n");
}
private void printTableEnd(PrintWriter pw) {
pw.print("</table>\n");
pw.print("<br/>");
}
private void printPageTitle(PrintWriter pw,String title,String titleContext,String description) {
pw.print("<h2>");
pw.print(title);
pw.print(" ");
if (titleContext!=null) {
pw.print(titleContext);
}
pw.print("</h2>\n");
if (description!=null) {
pw.print(description);
pw.print("<br/>\n");
}
}
private void printPageIndexTitle(PrintWriter pw,String title,String titleContext,String description) {
pw.print("<h1><center>");
pw.print(title);
pw.print(" ");
if (titleContext!=null) {
pw.print(titleContext);
}
pw.print("</center></h1>\n");
if (description!=null) {
pw.print(description);
}
}
private void printHeader(PrintWriter pw,String title,String pathPrefix) throws IOException {
pw.print("\n");
pw.print("<html>\n");
pw.print("<head>\n");
pw.print("<!-- Generated by ");
pw.print(EldDocHtmlWriter.class.getSimpleName());
pw.print(" on ");
pw.print(new Date());
pw.print("-->\n");
pw.print("<meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\"/>\n");
pw.print("<title>");
pw.print(title);
pw.print("</title>\n");
//pw.print("<meta name=\"date\" content=")
pw.print("<link rel=\"stylesheet\" type=\"text/css\" href=\""+pathPrefix+"stylesheet.css\" title=\"Style\"/>\n");
pw.print("</head>\n");
pw.print("<body>\n");
pw.print("<hr/>\n");
pw.print("<a name=\"navbar_top\"><!-- --></a>\n");
pw.print("<a href=\"#skip-navbar_top\" title=\"Skip navigation links\"></a>\n");
pw.print("<table border=\"0\" width=\"100%\" cellpadding=\"1\" cellspacing=\"0\" summary=\"\">\n");
pw.print("<tr>\n");
pw.print("<td colspan=\"2\" bgcolor=\"#EEEEFF\" class=\"NavBarCell1\">\n");
pw.print("<a name=\"navbar_top_firstrow\"><!-- --></a>\n");
pw.print("<table border=\"0\" cellpadding=\"1\" cellspacing=\"0\" summary=\"\">\n");
pw.print("<tr align=\"center\" valign=\"top\">\n");
//pw.print("<TD BGCOLOR=\"#EEEEFF\" CLASS=\"NavBarCell1Rev\"> &nbsp;<FONT CLASS=\"NavBarFont1Rev\"><B>Overview</B></FONT>&nbsp;</TD>\n");
printNavBar(pw,pathPrefix);
pw.print("</tr>\n");
pw.print("</table>\n");
pw.print("</td>\n");
pw.print("<td align=\"right\" valign=\"top\" rowspan=\"3\"><EM>\n</EM></td>");
pw.print("</tr>\n");
pw.print("<tr>\n");
pw.print("<TD BGCOLOR=\"white\" CLASS=\"NavBarCell2\"><FONT SIZE=\"-2\">\n");
pw.print("&nbsp;PREV&nbsp;&nbsp;NEXT</FONT></TD>\n");
pw.print("<TD BGCOLOR=\"white\" CLASS=\"NavBarCell2\"><FONT SIZE=\"-2\">...</TD>\n");
pw.print("</tr>\n");
pw.print("</table>\n");
pw.print("<a name=\"skip-navbar_top\"></a>\n");
pw.print("<hr/>\n");
pw.print("\n");
pw.flush();
}
private void printBottom(PrintWriter pw,String pathPrefix) throws IOException {
pw.print("<hr/>\n");
pw.print("<a name=\"navbar_bottom\"><!-- --></a>\n");
pw.print("<a href=\"#skip-navbar_bottom\" title=\"Skip navigation links\"></a>\n");
pw.print("<table border=\"0\" width=\"100%\" cellpadding=\"1\" cellspacing=\"0\" summary=\"\">\n");
pw.print("<tr>\n");
pw.print("<td colspan=\"2\" bgcolor=\"#EEEEFF\" class=\"NavBarCell1\">\n");
pw.print("<a name=\"navbar_bottom_firstrow\"><!-- --></a>\n");
pw.print("<table border=\"0\" cellpadding=\"1\" cellspacing=\"0\" summary=\"\">\n");
pw.print("<tr align=\"center\" valign=\"top\">\n");
printNavBar(pw,pathPrefix);
pw.print("</tr>\n");
pw.print("</table>\n");
pw.print("</td>\n");
pw.print("<td align=\"right\" valign=\"top\" rowspan=\"3\"><EM>\n</EM></td>");
pw.print("</tr>\n");
pw.print("<tr>\n");
pw.print("<TD BGCOLOR=\"white\" CLASS=\"NavBarCell2\"><FONT SIZE=\"-2\">\n");
pw.print("&nbsp;PREV&nbsp;&nbsp;NEXT</FONT></TD>\n");
pw.print("<TD BGCOLOR=\"white\" CLASS=\"NavBarCell2\"><FONT SIZE=\"-2\">...</TD>\n");
pw.print("</tr>\n");
pw.print("</table>\n");
pw.print("<a name=\"skip-navbar_bottom\"></a>\n");
pw.print("<hr/>\n");
pw.print("\n");
pw.print("Copyright &#169; todo. All Rights Reserved.\n");
pw.print("\n");
pw.print("</body>\n");
pw.print("</html>\n\n");
pw.flush();
}
private void printNavBar(PrintWriter pw,String pathPrefix) throws IOException {
pw.print("<td bgcolor=\"#EEEEFF\" class=\"NavBarCell1\"><a href=\""+pathPrefix+"index.html\"><font class=\"NavBarFont1\"><b>Index</B></font></a>&nbsp;</td>\n");
pw.print("<td bgcolor=\"#EEEEFF\" class=\"NavBarCell1\"><a href=\""+pathPrefix+"module-overview.html\"><font class=\"NavBarFont1\"><b>Modules</B></font></a>&nbsp;</td>\n");
pw.print("<td bgcolor=\"#EEEEFF\" class=\"NavBarCell1\"><a href=\""+pathPrefix+"namespace-overview.html\"><font class=\"NavBarFont1\"><b>Namespaces</B></font></a>&nbsp;</td>\n");
}
}

143
x4o-elddoc/src/main/java/org/x4o/xml/eld/doc/X4OLanguageEldDocWriter.java Normal file
View file

@ -0,0 +1,143 @@
/*
* Copyright (c) 2004-2012, Willem Cazander
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided
* that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright notice, this list of conditions and the
* following disclaimer.
* * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and
* the following disclaimer in the documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
* THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
* OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
* TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.x4o.xml.eld.doc;
import java.io.File;
import java.util.Arrays;
import java.util.Iterator;
import java.util.List;
import org.x4o.xml.core.X4OParserSupport;
import org.x4o.xml.core.X4OParserSupportException;
import org.x4o.xml.core.config.X4OLanguageClassLoader;
import org.x4o.xml.element.ElementLanguage;
import org.x4o.xml.element.ElementException;
/**
* X4OLanguageHtmlWriter is support class to write html documentation from the eld.
*
* @author Willem Cazander
* @version 1.0 Aug 22, 2012
*/
public class X4OLanguageEldDocWriter {
private Class<?> languageParserSupport = null;
private File basePath;
@SuppressWarnings("unchecked")
static public void main(String argu[]) {
X4OLanguageEldDocWriter languageSchema = new X4OLanguageEldDocWriter();
List<String> arguList = Arrays.asList(argu);
Iterator<String> arguIterator = arguList.iterator();
while (arguIterator.hasNext()) {
String arg = arguIterator.next();
if ("-path".equals(arg)) {
if (arguIterator.hasNext()==false) {
System.out.println("No argument for -path given.");
System.exit(1);
return;
}
File schemaBasePath = new File(arguIterator.next());
if (schemaBasePath.exists()==false) {
System.out.println("path does not exists; "+schemaBasePath);
System.exit(1);
return;
}
languageSchema.setBasePath(schemaBasePath);
continue;
}
if ("-class".equals(arg)) {
if (arguIterator.hasNext()==false) {
System.out.println("No argument for -class given.");
System.exit(1);
return;
}
String apiClass = arguIterator.next();
try {
languageSchema.setLanguageParserSupport((Class<X4OParserSupport>) X4OLanguageClassLoader.loadClass(apiClass));
} catch (ClassNotFoundException e) {
System.out.println("Schema api class is not found: "+apiClass);
System.exit(1);
return;
}
continue;
}
}
try {
languageSchema.execute();
} catch (X4OParserSupportException e) {
System.out.println("Error while schema writing: "+e.getMessage());
e.printStackTrace();
System.exit(1);
return;
}
}
public void execute() throws X4OParserSupportException {
try {
// Load the support language context
X4OParserSupport languageSupport = (X4OParserSupport)getLanguageParserSupport().newInstance();
ElementLanguage context = languageSupport.loadElementLanguageSupport();
// Start doc generator
EldDocGenerator generator = new EldDocGenerator(context);
generator.writeDoc(getBasePath());
} catch (InstantiationException e) {
throw new X4OParserSupportException(e);
} catch (IllegalAccessException e) {
throw new X4OParserSupportException(e);
} catch (ElementException e) {
throw new X4OParserSupportException(e);
}
}
/**
* @return the languageParserSupport
*/
public Class<?> getLanguageParserSupport() {
return languageParserSupport;
}
/**
* @param languageParserSupport the languageParserSupport to set
*/
public void setLanguageParserSupport(Class<?> languageParserSupport) {
this.languageParserSupport = languageParserSupport;
}
/**
* @return the basePath
*/
public File getBasePath() {
return basePath;
}
/**
* @param basePath the basePath to set
*/
public void setBasePath(File basePath) {
this.basePath = basePath;
}
}

30
x4o-elddoc/src/main/java/org/x4o/xml/eld/doc/package-info.java Normal file
View file

@ -0,0 +1,30 @@
/*
* Copyright (c) 2004-2012, Willem Cazander
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided
* that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright notice, this list of conditions and the
* following disclaimer.
* * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and
* the following disclaimer in the documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
* THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
* OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
* TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/**
* The X4O ELD documentation classes.
*
* @since 1.0
*/
package org.x4o.xml.eld.doc;

79
x4o-elddoc/src/test/java/org/x4o/xml/eld/doc/EldDocTest.java Normal file
View file

@ -0,0 +1,79 @@
/*
* Copyright (c) 2004-2012, Willem Cazander
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided
* that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright notice, this list of conditions and the
* following disclaimer.
* * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and
* the following disclaimer in the documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
* THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
* OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
* TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.x4o.xml.eld.doc;
import java.io.File;
import org.x4o.xml.eld.EldParserSupport;
import org.x4o.xml.test.TestParserSupport;
import org.x4o.xml.test.swixml.SwiXmlParserSupport3;
import junit.framework.TestCase;
/**
* Test for eld doc generation
*
* @author Willem Cazander
* @version 1.0 Aug 26, 2010
*/
public class EldDocTest extends TestCase {
private File getTempPath(String dir) throws Exception {
File tempFile = File.createTempFile("test-path", ".tmp");
String absolutePath = tempFile.getAbsolutePath();
String tempPath = absolutePath.substring(0,absolutePath.lastIndexOf(File.separator)+1);
tempFile.delete();
File result = new File(tempPath+File.separator+dir);
if (result.exists()==false) {
result.mkdir();
}
return result;
}
public void testEldDoc() throws Exception {
X4OLanguageEldDocWriter writer = new X4OLanguageEldDocWriter();
writer.setBasePath(getTempPath("junit-eld"));
writer.setLanguageParserSupport(EldParserSupport.class);
writer.execute();
}
public void testUnitDoc() throws Exception {
X4OLanguageEldDocWriter writer = new X4OLanguageEldDocWriter();
writer.setBasePath(getTempPath("junit-test"));
writer.setLanguageParserSupport(TestParserSupport.class);
writer.execute();
}
public void testSwiXml3Doc() throws Exception {
X4OLanguageEldDocWriter writer = new X4OLanguageEldDocWriter();
writer.setBasePath(getTempPath("junit-swixml3"));
writer.setLanguageParserSupport(SwiXmlParserSupport3.class);
writer.execute();
}
public void testEldDocMain() throws Exception {
X4OLanguageEldDocWriter.main(new String[] {"-path",getTempPath("junit-test-main").getAbsolutePath(),"-class",EldParserSupport.class.getName()});
}
}

0
x4o-elddoc/src/test/resources/.empty Normal file
View file