arch-jedi/nx01
1
0
Fork 0
Code Issues Pull requests Releases Packages Activity Actions

X4O: Formatted plugins and maisdoc

Browse source
This commit is contained in:
Willem Cazander 2025-11-07 21:48:59 +01:00
parent a61ce241e1
commit bd4a04a813
63 changed files with 1690 additions and 1589 deletions
Download patch file Download diff file Expand all files Collapse all files

2
nx01-x4o-maisdoc/src/main/java/org/x4o/maisdoc/MaisDocProject.java
View file

@ -33,5 +33,5 @@ public class MaisDocProject {
private Class<?> frameNavConceptClass = null;
private List<MaisDocProjectPerspective> perspectives;
}

2
nx01-x4o-maisdoc/src/main/java/org/x4o/maisdoc/MaisDocProjectPerspective.java
View file

@ -33,7 +33,7 @@ import java.util.List;
public class MaisDocProjectPerspective {
private List<MaisDocProjectPerspectiveWing> wasps = new ArrayList<>();
public List<MaisDocProjectPerspectiveWing> getWasps() {
return wasps;
}

3
nx01-x4o-maisdoc/src/main/java/org/x4o/maisdoc/MaisDocProjectPerspectiveWing.java
View file

@ -38,7 +38,6 @@ public interface MaisDocProjectPerspectiveWing {
// use: doc.addAnnotatedClasses
// use: doc.addConcept
// use: doc.addDocPage
// use: waspNode.addNode
}

78
nx01-x4o-maisdoc/src/main/java/org/x4o/maisdoc/MaisDocWriter.java
View file

@ -49,12 +49,13 @@ import org.x4o.sax3.io.SAX3PropertyConfig.PropertyConfigItem;
*/
@Deprecated // marked until make working to write multiple project or mix api docs in one big tree
public class MaisDocWriter {
// NOTE: this class is unused, and is waiting for ApiDocProject code and replaces most code in EldDocWriter to here.
private final static String PROPERTY_CONTEXT_PREFIX = SAX3PropertyConfig.X4O_PROPERTIES_PREFIX+"api-doc/";
private final static String PROPERTY_CONTEXT_PREFIX = SAX3PropertyConfig.X4O_PROPERTIES_PREFIX + "api-doc/";
public final static SAX3PropertyConfig DEFAULT_PROPERTY_CONFIG;
//@formatter:off
public final static String OUTPUT_PATH = PROPERTY_CONTEXT_PREFIX+"output/path";
public final static String DOC_NAME = PROPERTY_CONTEXT_PREFIX+"doc/name";
public final static String DOC_DESCRIPTION = PROPERTY_CONTEXT_PREFIX+"doc/description";
@ -92,18 +93,20 @@ public class MaisDocWriter {
new PropertyConfigItem(PAGE_PRINT_HELP,Boolean.class,true)
);
}
//@formatter:on
/** The config of this writer. */
private final SAX3PropertyConfig propertyConfig;
public MaisDocWriter(SAX3PropertyConfig parentConfig) {
this.propertyConfig=new SAX3PropertyConfig(DEFAULT_PROPERTY_CONFIG,PROPERTY_CONTEXT_PREFIX);
this.propertyConfig = new SAX3PropertyConfig(DEFAULT_PROPERTY_CONFIG, PROPERTY_CONTEXT_PREFIX);
this.propertyConfig.copyParentProperties(parentConfig);
}
/**
* Writes the language documentation to the base path.
* @throws IOException Is thrown when error is done.
*
* @throws IOException Is thrown when error is done.
*/
public void writeDocumentation() throws IOException {
File basePath = propertyConfig.getPropertyFile(OUTPUT_PATH);
@ -111,43 +114,44 @@ public class MaisDocWriter {
MaisDoc doc = buildLanguageDoc();
writer.write(doc, basePath);
}
/**
* Creates a fully configured ApiDoc object.
* @return The ApiDoc configured to write eld documentation.
*
* @return The ApiDoc configured to write eld documentation.
*/
private MaisDoc buildLanguageDoc() {
// Generic config
MaisDoc doc = new MaisDoc();
doc.setName( propertyConfig.getPropertyString(DOC_NAME));
doc.setDescription( propertyConfig.getPropertyString(DOC_DESCRIPTION));
doc.setDocAbout( propertyConfig.getPropertyString(DOC_ABOUT, () -> createDefaultAbout(doc.getName())));
doc.setDocCopyright( propertyConfig.getPropertyString(DOC_COPYRIGHT, () -> createForeverCopyright()));
doc.setDocPageSubTitle( propertyConfig.getPropertyString(DOC_PAGE_SUB_TITLE, () -> createDefaultPageSubTitle(doc.getName())));
doc.setMetaStyleSheetThema( propertyConfig.getPropertyString(META_STYLESHEET_THEMA));
doc.setMetaStyleSheet( propertyConfig.getPropertyFile(META_STYLESHEET));
doc.addMetaKeywordAll( propertyConfig.getPropertyList(META_KEYWORDS, () -> createDefaultKeywords()));
doc.setNoFrameAllName( propertyConfig.getPropertyString(DOC_NO_FRAME_ALL_NAME));
doc.setName(propertyConfig.getPropertyString(DOC_NAME));
doc.setDescription(propertyConfig.getPropertyString(DOC_DESCRIPTION));
doc.setDocAbout(propertyConfig.getPropertyString(DOC_ABOUT, () -> createDefaultAbout(doc.getName())));
doc.setDocCopyright(propertyConfig.getPropertyString(DOC_COPYRIGHT, () -> createForeverCopyright()));
doc.setDocPageSubTitle(propertyConfig.getPropertyString(DOC_PAGE_SUB_TITLE, () -> createDefaultPageSubTitle(doc.getName())));
doc.setMetaStyleSheetThema(propertyConfig.getPropertyString(META_STYLESHEET_THEMA));
doc.setMetaStyleSheet(propertyConfig.getPropertyFile(META_STYLESHEET));
doc.addMetaKeywordAll(propertyConfig.getPropertyList(META_KEYWORDS, () -> createDefaultKeywords()));
doc.setNoFrameAllName(propertyConfig.getPropertyString(DOC_NO_FRAME_ALL_NAME));
doc.setFrameNavPrintParent(true);
doc.setFrameNavPrintParentId(true);
doc.setGroupTypeName("summary", "Summary",1);
doc.setGroupTypeName("overview", "Overview",2);
doc.setGroupTypeName("summary", "Summary", 1);
doc.setGroupTypeName("overview", "Overview", 2);
// Javadoc linking config
List<String> javadocLinkList = propertyConfig.getPropertyList(JAVADOC_LINK);
Map<String,String> javadocLinkOfflineMap = propertyConfig.getPropertyMap(JAVADOC_LINK_OFFLINE);
if (javadocLinkList!=null) {
for (String javadocUrl:javadocLinkList) {
Map<String, String> javadocLinkOfflineMap = propertyConfig.getPropertyMap(JAVADOC_LINK_OFFLINE);
if (javadocLinkList != null) {
for (String javadocUrl : javadocLinkList) {
doc.addRemoteClass(new MaisDocRemoteClass(javadocUrl));
}
}
if (javadocLinkOfflineMap!=null) {
for (Map.Entry<String,String> offlineLink:javadocLinkOfflineMap.entrySet()) {
doc.addRemoteClass(new MaisDocRemoteClass(offlineLink.getKey(),offlineLink.getValue()));
if (javadocLinkOfflineMap != null) {
for (Map.Entry<String, String> offlineLink : javadocLinkOfflineMap.entrySet()) {
doc.addRemoteClass(new MaisDocRemoteClass(offlineLink.getKey(), offlineLink.getValue()));
}
}
// Tree and navagation config
// doc.setFrameNavConceptClass(ElementClass.class);
//
@ -168,7 +172,7 @@ public class MaisDocWriter {
// ApiDocConcept adcIface = doc.addConcept(new ApiDocConcept(adcMod,C_INTERFACE,ElementInterface.class));
// ApiDocConcept adcNs = doc.addConcept(new ApiDocConcept(adcMod,C_NAMESPACE,ElementNamespace.class));
// ApiDocConcept adcEc = doc.addConcept(new ApiDocConcept(adcNs,C_ELEMENT,ElementClass.class));
// mm maybe redo something here
// adcMod.addChildConcepts(new ApiDocConcept(adcMod,CC_ATTRIBUTE_H,ElementNamespaceAttribute.class));
// adcMod.addChildConcepts(new ApiDocConcept(adcMod,CC_CONFIGURATOR_G,ElementConfiguratorGlobal.class));
@ -177,13 +181,13 @@ public class MaisDocWriter {
// adcIface.addChildConcepts(new ApiDocConcept(adcMod,CC_CONFIGURATOR,ElementConfigurator.class));
// adcEc.addChildConcepts(new ApiDocConcept(adcEc,CC_CONFIGURATOR,ElementConfigurator.class));
// adcEc.addChildConcepts(new ApiDocConcept(adcEc,CC_ATTRIBUTE,ElementClassAttribute.class));
// Non-tree pages config
// if (propertyConfig.getPropertyBoolean(PAGE_PRINT_XTREE)) { doc.addDocPage(EldDocXTreePageWriter.createDocPage()); }
// if (propertyConfig.getPropertyBoolean(PAGE_PRINT_TREE)) { doc.addDocPage(DefaultPageWriterTree.createDocPage()); }
// if (propertyConfig.getPropertyBoolean(PAGE_PRINT_INDEX_ALL)) { doc.addDocPage(DefaultPageWriterIndexAll.createDocPage()); }
// if (propertyConfig.getPropertyBoolean(PAGE_PRINT_HELP)) { doc.addDocPage(DefaultPageWriterHelp.createDocPage()); }
// Doc tree config
// ApiDocNode rootNode = new ApiDocNode(language,"language",getLanguageNameUpperCase()+" Language","The X4O "+getLanguageNameUpperCase()+" Language");
// doc.setRootNode(rootNode);
@ -201,7 +205,7 @@ public class MaisDocWriter {
// }
return doc;
}
private String createDefaultPageSubTitle(String name) {
StringBuilder buf = new StringBuilder(100);
buf.append(name);
@ -209,7 +213,7 @@ public class MaisDocWriter {
buf.append("API");
return buf.toString();
}
private String createDefaultAbout(String name) {
Calendar calendar = Calendar.getInstance();
StringBuilder buf = new StringBuilder(100);
@ -218,7 +222,7 @@ public class MaisDocWriter {
buf.append(calendar.get(Calendar.YEAR));
return buf.toString();
}
private String createForeverCopyright() {
StringBuilder buf = new StringBuilder(100);
buf.append("Copyright&nbsp;&#x00a9;&nbsp;");
@ -229,7 +233,7 @@ public class MaisDocWriter {
buf.append("All Rights Reserved.");
return buf.toString();
}
private List<String> createDefaultKeywords() {
List<String> keywords = new ArrayList<String>(10);
keywords.add("language");

19
nx01-x4o-maisdoc/src/main/java/org/x4o/maisdoc/flake/DefaultPageWriterHelp.java
View file

@ -38,33 +38,35 @@ import org.x4o.sax3.SAX3WriterHtml.Tag;
* @version 1.0 May 22, 2013
*/
public class DefaultPageWriterHelp implements MaisDocPageWriter {
public static MaisDocPage createDocPage() {
return new MaisDocPage("doc-help","Help","This help file applies to the API documentation generated using the standard format.",new DefaultPageWriterHelp());
return new MaisDocPage("doc-help", "Help", "This help file applies to the API documentation generated using the standard format.",
new DefaultPageWriterHelp());
}
public void writePageContent(MaisDocWriteEvent<MaisDocPage> e) throws IOException {
MaisDoc doc = e.getDoc();
//ApiDocPage page = e.getEvent();
// ApiDocPage page = e.getEvent();
MaisDocContentWriter writer = e.getWriter();
//@formatter:off
writer.printTagStart(Tag.div,"header");
writer.printTagCharacters(Tag.h1, "How This API Document Is Organized", "title");
writer.printTagStart(Tag.div,"subTitle");
writer.printTagStart(Tag.div, "subTitle");
writer.printCharacters("This ApiDoc document has pages corresponding to the items in the navigation bar, described as follows.");
writer.printTagEnd(Tag.div);
writer.printTagEnd(Tag.div);
writer.docPageContentStart();
writer.docPageBlockStart();
for (MaisDocConcept concept:doc.getConcepts()) {
for (MaisDocConcept concept : doc.getConcepts()) {
writer.printTagCharacters(Tag.h2, concept.getName());
writer.printTagStart(Tag.p);
writer.printCharacters(concept.getDescriptionHelp());
writer.printTagEnd(Tag.p);
writer.docPageBlockNext();
}
for (MaisDocPage docPage:doc.getDocPages()) {
for (MaisDocPage docPage : doc.getDocPages()) {
writer.printTagCharacters(Tag.h2, docPage.getName());
writer.printTagStart(Tag.p);
writer.printCharacters(docPage.getDescription());
@ -73,5 +75,6 @@ public class DefaultPageWriterHelp implements MaisDocPageWriter {
}
writer.docPageBlockEnd();
writer.docPageContentEnd();
//@formatter:on
}
}

20
nx01-x4o-maisdoc/src/main/java/org/x4o/maisdoc/flake/DefaultPageWriterIndexAll.java
View file

@ -36,23 +36,23 @@ import org.x4o.sax3.SAX3WriterHtml.Tag;
* @version 1.0 May 22, 2013
*/
public class DefaultPageWriterIndexAll implements MaisDocPageWriter {
public static MaisDocPage createDocPage() {
return new MaisDocPage("index-all","Index","Index of all api ketwords.",new DefaultPageWriterIndexAll());
return new MaisDocPage("index-all", "Index", "Index of all api ketwords.", new DefaultPageWriterIndexAll());
}
public void writePageContent(MaisDocWriteEvent<MaisDocPage> e) throws IOException {
// ApiDoc doc = e.getDoc();
// ApiDocPage page = e.getEvent();
// ApiDoc doc = e.getDoc();
// ApiDocPage page = e.getEvent();
MaisDocContentWriter writer = e.getWriter();
writer.docPageContentStart();
for (char i='A';i<='Z';i++) {
writer.printHref("#_"+i+"_", ""+i);
for (char i = 'A'; i <= 'Z'; i++) {
writer.printHref("#_" + i + "_", "" + i);
writer.printCharacters("&nbsp;");
}
for (char i='A';i<='Z';i++) {
writer.printHrefNamed("_"+i+"_");
writer.printTagCharacters(Tag.h2, ""+i);
for (char i = 'A'; i <= 'Z'; i++) {
writer.printHrefNamed("_" + i + "_");
writer.printTagCharacters(Tag.h2, "" + i);
writer.printCharacters("TODO");
}
writer.docPageContentEnd();

50
nx01-x4o-maisdoc/src/main/java/org/x4o/maisdoc/flake/DefaultPageWriterTree.java
View file

@ -38,68 +38,68 @@ import org.x4o.sax3.SAX3WriterHtml.Tag;
* @version 1.0 May 22, 2013
*/
public class DefaultPageWriterTree implements MaisDocPageWriter {
public static MaisDocPage createDocPage() {
return new MaisDocPage("overview-tree","Tree","Tree of api concepts.",new DefaultPageWriterTree());
return new MaisDocPage("overview-tree", "Tree", "Tree of api concepts.", new DefaultPageWriterTree());
}
protected MaisDocNode selectRootNode(MaisDoc doc) {
MaisDocNode rootNode = doc.getRootNodeTreePage();
if (rootNode==null) {
if (rootNode == null) {
rootNode = doc.getRootNode();
}
return rootNode;
}
public void writePageContent(MaisDocWriteEvent<MaisDocPage> e) throws IOException {
MaisDoc doc = e.getDoc();
MaisDocPage page = e.getEventObject();
MaisDocContentWriter writer = e.getWriter();
//writer.docPagePackageTitle(title, "Overview Tree");
// writer.docPagePackageTitle(title, "Overview Tree");
writer.docPageContentStart();
writeTree(doc,selectRootNode(doc),writer,"");
writer.docPagePackageDescription(page.getName(), "Tree","All Language elements as tree.");
writeTree(doc, selectRootNode(doc), writer, "");
writer.docPagePackageDescription(page.getName(), "Tree", "All Language elements as tree.");
writer.docPageContentEnd();
}
private void writeTree(MaisDoc doc, MaisDocNode node,MaisDocContentWriter writer,String pathPrefix) throws IOException {
for (Class<?> excludeClass:doc.getTreeNodeClassExcludes()) {
private void writeTree(MaisDoc doc, MaisDocNode node, MaisDocContentWriter writer, String pathPrefix) throws IOException {
for (Class<?> excludeClass : doc.getTreeNodeClassExcludes()) {
if (excludeClass.isAssignableFrom(node.getUserData().getClass())) {
return;
}
}
StringBuilder buf = new StringBuilder();
if (!doc.getRootNode().equals(node)) {
buildParentPath(node,buf);
buildParentPath(node, buf);
}
buf.append("index.html");
String href = buf.toString();
writer.printTagStart(Tag.ul);
writer.printTagStart(Tag.li,"",null,"circle");
if (node.getParent()!=null) {
writer.printTagStart(Tag.li, "", null, "circle");
if (node.getParent() != null) {
writer.printCharacters(node.getParent().getId());
writer.printCharacters(":");
}
writer.printHref(href, node.getName(), node.getName(), "strong");
writer.printTagEnd(Tag.li);
for (MaisDocNode child:node.getNodes()) {
writeTree(doc,child,writer,pathPrefix);
for (MaisDocNode child : node.getNodes()) {
writeTree(doc, child, writer, pathPrefix);
}
writer.printTagEnd(Tag.ul);
}
private void buildParentPath(MaisDocNode node,StringBuilder buf) {
if (node.getParent()==null) {
private void buildParentPath(MaisDocNode node, StringBuilder buf) {
if (node.getParent() == null) {
buf.append(MaisDocContentWriter.toSafeUri(node.getId()));
buf.append('/');
return;
}
buildParentPath(node.getParent(),buf);
buildParentPath(node.getParent(), buf);
buf.append(MaisDocContentWriter.toSafeUri(node.getId()));
buf.append('/');
}

21
nx01-x4o-maisdoc/src/main/java/org/x4o/maisdoc/flake/MaisDocContentCss.java
View file

@ -29,28 +29,28 @@ package org.x4o.maisdoc.flake;
* @version 1.0 May 20, 2013
*/
public enum MaisDocContentCss {
indexHeader,
indexContainer,
bar,
block,
blockList,
strong,
topNav,
bottomNav,
navList,
navBarCell1Rev,
subNav,
subNavList,
subTitle,
tabEnd,
aboutLanguage,
legalCopy,
inheritance,
header,
description,
@ -60,19 +60,18 @@ public enum MaisDocContentCss {
contentContainer,
packageSummary,
overviewSummary,
colOne,
colFirst,
colLast,
altColor,
rowColor,
// frame names maybe can be used to create frame-less html5 JS version
frameNavOverview,
frameNavDetail,
frameContent,
;
frameContent,;
//
// TODO: write new CSS spec for html root tag to have tag+style class guards in CSS.
// because this sun css of above defines the allowed (styled) html tree structure.

128
nx01-x4o-maisdoc/src/main/java/org/x4o/maisdoc/flake/MaisDocContentPrinter.java
View file

@ -42,84 +42,80 @@ import org.x4o.maisdoc.model.MaisDocWriteEvent;
*/
public interface MaisDocContentPrinter {
default void clearHrefContentGroup(MaisDoc doc,MaisDocNode node,String groupType,String group,Class<?> filterClass) {
boolean doClear = filterUserDataClassType(node,filterClass).isEmpty();
if (doClear==false) {
default void clearHrefContentGroup(MaisDoc doc, MaisDocNode node, String groupType, String group, Class<?> filterClass) {
boolean doClear = filterUserDataClassType(node, filterClass).isEmpty();
if (doClear == false) {
return;
}
clearHrefContentGroupAlways(doc,groupType,group);
clearHrefContentGroupAlways(doc, groupType, group);
}
default void clearHrefContentGroupAlways(MaisDoc doc,String groupType,String group) {
MaisDocNavLink link = doc.getNodeData().getGroupTypeLink(groupType,group);
if (link==null) {
default void clearHrefContentGroupAlways(MaisDoc doc, String groupType, String group) {
MaisDocNavLink link = doc.getNodeData().getGroupTypeLink(groupType, group);
if (link == null) {
return;
}
link.setHref(null);
}
default void printApiTable(MaisDocWriteEvent<MaisDocNode> event,String name,Class<?> interfaceClass) throws IOException {
printApiTable(
event.getEventObject(),
filterUserDataClassType(event.getEventObject(),interfaceClass),
event.getWriter(),
name
);
default void printApiTable(MaisDocWriteEvent<MaisDocNode> event, String name, Class<?> interfaceClass) throws IOException {
printApiTable(event.getEventObject(), filterUserDataClassType(event.getEventObject(), interfaceClass), event.getWriter(), name);
}
default void printApiTable(MaisDocNode parent,List<MaisDocNode> nodes,MaisDocContentWriter writer,String name) throws IOException {
default void printApiTable(MaisDocNode parent, List<MaisDocNode> nodes, MaisDocContentWriter writer, String name) throws IOException {
if (nodes.isEmpty()) {
return;
}
writer.docTableStart(name, "All childeren in "+name,MaisDocContentCss.overviewSummary);
writer.docTableStart(name, "All childeren in " + name, MaisDocContentCss.overviewSummary);
writer.docTableHeader("Name", "Description");
for (MaisDocNode child:nodes) {
String link = MaisDocContentWriter.toSafeUri(child.getId())+"/index.html";
if (parent.getParent()==null) {
link = MaisDocContentWriter.toSafeUri(parent.getId())+"/"+link; // root node
for (MaisDocNode child : nodes) {
String link = MaisDocContentWriter.toSafeUri(child.getId()) + "/index.html";
if (parent.getParent() == null) {
link = MaisDocContentWriter.toSafeUri(parent.getId()) + "/" + link; // root node
}
writer.docTableRowLink(link,child.getName(),child.getDescription());
writer.docTableRowLink(link, child.getName(), child.getDescription());
}
writer.docTableEnd();
}
private List<MaisDocNode> filterUserDataClassType(MaisDocNode filterNode,Class<?> interfaceClass) {
List<MaisDocNode> result = new ArrayList<MaisDocNode>(filterNode.getNodes().size()/2);
for (MaisDocNode node:filterNode.getNodes()) {
private List<MaisDocNode> filterUserDataClassType(MaisDocNode filterNode, Class<?> interfaceClass) {
List<MaisDocNode> result = new ArrayList<MaisDocNode>(filterNode.getNodes().size() / 2);
for (MaisDocNode node : filterNode.getNodes()) {
if (interfaceClass.isAssignableFrom(node.getUserData().getClass())) {
result.add(node);
}
}
return result;
}
default void printApiTableBean(MaisDocWriteEvent<MaisDocNode> event,String name,String...skipProperties) throws IOException {
default void printApiTableBean(MaisDocWriteEvent<MaisDocNode> event, String name, String... skipProperties) throws IOException {
printApiTableBean(event.getDoc(), event.getWriter(), event.getEventObject().getUserData(), name, skipProperties);
}
default void printApiTableBean(MaisDoc doc,MaisDocContentWriter writer,Object bean,String name,String...skipProperties) throws IOException {
default void printApiTableBean(MaisDoc doc, MaisDocContentWriter writer, Object bean, String name, String... skipProperties) throws IOException {
printApiTableBeanClass(doc, writer, bean, bean.getClass(), name, skipProperties);
}
default void printApiTableBeanClass(MaisDocWriteEvent<MaisDocNode> event,Class<?> beanClass,String name,String...skipProperties) throws IOException {
printApiTableBeanClass(event.getDoc(), event.getWriter(), null,beanClass, name, skipProperties);
default void printApiTableBeanClass(MaisDocWriteEvent<MaisDocNode> event, Class<?> beanClass, String name, String... skipProperties) throws IOException {
printApiTableBeanClass(event.getDoc(), event.getWriter(), null, beanClass, name, skipProperties);
}
private void printApiTableBeanClass(MaisDoc doc,MaisDocContentWriter writer,Object bean,Class<?> beanClass,String name,String...skipProperties) throws IOException {
writer.docTableStart(name+" Properties", name+" properties overview.",MaisDocContentCss.overviewSummary);
private void printApiTableBeanClass(MaisDoc doc, MaisDocContentWriter writer, Object bean, Class<?> beanClass, String name, String... skipProperties)
throws IOException {
writer.docTableStart(name + " Properties", name + " properties overview.", MaisDocContentCss.overviewSummary);
writer.docTableHeader("Name", "Value");
for (Method m:beanClass.getMethods()) {
for (Method m : beanClass.getMethods()) {
if (m.getName().startsWith("get")) {
String n = m.getName().substring(3);
if (m.getParameterTypes().length!=0) {
if (m.getParameterTypes().length != 0) {
continue; // set without parameters
}
if (n.length()<2) {
if (n.length() < 2) {
continue;
}
n = n.substring(0,1).toLowerCase()+n.substring(1,n.length());
n = n.substring(0, 1).toLowerCase() + n.substring(1, n.length());
boolean skipNext = false;
for (String skip:skipProperties) {
for (String skip : skipProperties) {
if (n.equals(skip)) {
skipNext = true;
break;
@ -128,9 +124,9 @@ public interface MaisDocContentPrinter {
if (skipNext) {
continue;
}
Object value = null;
if (bean!=null) {
if (bean != null) {
try {
value = m.invoke(bean, new Object[] {});
} catch (IllegalArgumentException e) {
@ -143,10 +139,10 @@ public interface MaisDocContentPrinter {
} else {
value = m.getReturnType();
}
//writer.docTableRow(n,);
// writer.docTableRow(n,);
writer.docTableRowLastStart(n, null);
String c = printValue(doc,writer,value);
if (c!=null) {
String c = printValue(doc, writer, value);
if (c != null) {
writer.printCharacters(c);
}
writer.docTableRowLastEnd();
@ -154,37 +150,37 @@ public interface MaisDocContentPrinter {
}
writer.docTableEnd();
}
private String printValue(MaisDoc doc,MaisDocContentWriter writer,Object value) throws IOException {
if (value==null) {
private String printValue(MaisDoc doc, MaisDocContentWriter writer, Object value) throws IOException {
if (value == null) {
return "null";
}
if (value instanceof String) {
return (String)value;
return (String) value;
}
if (value instanceof Class) {
Class<?> cls = (Class<?>)value;
for (MaisDocRemoteClass rc:doc.getRemoteClasses()) {
Class<?> cls = (Class<?>) value;
for (MaisDocRemoteClass rc : doc.getRemoteClasses()) {
String remoteUrl = rc.getRemoteUrl(cls);
if (remoteUrl==null) {
if (remoteUrl == null) {
continue;
}
writer.printHref(remoteUrl, cls.getSimpleName(), cls.getName());
return null;
}
return "class "+cls.getName();
return "class " + cls.getName();
}
if (value instanceof List) {
StringBuilder buf = new StringBuilder(100);
buf.append("[L: ");
List<?> l = (List<?>)value;
List<?> l = (List<?>) value;
if (l.isEmpty()) {
buf.append("Empty");
}
for (Object o:l) {
buf.append(""+o);
for (Object o : l) {
buf.append("" + o);
buf.append(" ");
}
buf.append("]");
@ -193,18 +189,18 @@ public interface MaisDocContentPrinter {
if (value instanceof Object[]) {
StringBuilder buf = new StringBuilder(100);
buf.append("[A: ");
Object[] l = (Object[])value;
if (l.length==0) {
Object[] l = (Object[]) value;
if (l.length == 0) {
buf.append("Empty");
}
for (Object o:l) {
buf.append(""+o);
for (Object o : l) {
buf.append("" + o);
buf.append(" ");
}
buf.append("]");
return buf.toString();
}
return value.toString();
}
}

162
nx01-x4o-maisdoc/src/main/java/org/x4o/maisdoc/flake/MaisDocContentWriter.java
View file

@ -39,23 +39,24 @@ import org.xml.sax.helpers.AttributesImpl;
* @version 1.0 Apr 30, 2013
*/
public class MaisDocContentWriter extends SAX3WriterHtml {
private boolean isRowAlt = false;
public MaisDocContentWriter(Writer out, String encoding) {
super(out,encoding);
super(out, encoding);
}
public void docCommentGenerated() throws IOException {
printComment("Generated by " + MaisDocContentWriter.class.getSimpleName( )+ " on " + new Date());
printComment("Generated by " + MaisDocContentWriter.class.getSimpleName() + " on " + new Date());
}
public void docHtmlStart(String title,List<String> keywords, String pathPrefix) throws IOException {
public void docHtmlStart(String title, List<String> keywords, String pathPrefix) throws IOException {
printDocType(DocType.HTML_4_TRANSITIONAL);
printComment("NewPage");
printHtmlStart("en");
// ====== Write head
//@formatter:off
printTagStart(Tag.head);
docCommentGenerated();
printHeadMetaContentType();
@ -67,36 +68,41 @@ public class MaisDocContentWriter extends SAX3WriterHtml {
printHeadLinkCss(pathPrefix+"resources/stylesheet.css");
printScriptSrc(pathPrefix+"resources/api-theme.js");
printTagEnd(Tag.head);
//@formatter:on
// ======= Write body
printTagStart(Tag.body);
StringBuilder script = new StringBuilder();
script.append("\n");
script.append("\tif (location.href.indexOf('is-external=true') == -1) {\n");
script.append("\t\ttry {\n");
script.append("\t\t\tparent.document.title=\"");script.append(title);script.append("\";\n");
script.append("\t\t\tparent.document.title=\"");
script.append(title);
script.append("\";\n");
script.append("\t\t} catch (e) {}\n");
script.append("\t}\n");
printScriptInline(script.toString());
printScriptNoDiv();
}
public void docHtmlEnd(String copyright, String statsJS) throws IOException {
//@formatter:off
printTagStart(Tag.p,MaisDocContentCss.legalCopy);
printTagStart(Tag.small);
printCharacters(copyright);
printTagEnd(Tag.small);
printTagEnd(Tag.p);
//@formatter:on
if (statsJS != null) {
printScriptInline(statsJS);
}
printTagEnd(Tag.body);
printHtmlEnd();
}
public void docNavBarAbout(String about) throws IOException {
printTagStart(Tag.div,MaisDocContentCss.aboutLanguage); // Print about language
printTagStart(Tag.div, MaisDocContentCss.aboutLanguage); // Print about language
printTagStart(Tag.em);
printTagStart(Tag.strong);
String[] lines = about.split("\n");
@ -109,58 +115,60 @@ public class MaisDocContentWriter extends SAX3WriterHtml {
}
printTagEnd(Tag.strong);
printTagEnd(Tag.em);
printTagEnd(Tag.div);
printTagEnd(Tag.div);
}
public void docPagePackageTitle(String title, String summary) throws IOException {
printTagStart(Tag.div,MaisDocContentCss.header);
printTagCharacters(Tag.h1, title,"title");
printTagStart(Tag.div,MaisDocContentCss.docSummary);
printTagCharacters(Tag.div, summary,MaisDocContentCss.block.name());
//@formatter:off
printTagStart(Tag.div, MaisDocContentCss.header);
printTagCharacters(Tag.h1, title, "title");
printTagStart(Tag.div, MaisDocContentCss.docSummary);
printTagCharacters(Tag.div, summary, MaisDocContentCss.block.name());
printTagEnd(Tag.div);
printTagStart(Tag.p);
printCharacters("See:&nbsp;");
printHref("#package_description", "Description");
printTagEnd(Tag.p);
printTagEnd(Tag.div);
//@formatter:on
}
public void docPagePackageDescription(String title, String summary, String description) throws IOException {
printHrefNamed("package_description");
printTagCharacters(Tag.h2, title);
printTagCharacters(Tag.div, summary,MaisDocContentCss.block.name());
printTagCharacters(Tag.div, summary, MaisDocContentCss.block.name());
printCharacters(description);
}
public void docPageClassStart(String title, String subTitle, Tag titleTag) throws IOException {
printComment("======== START OF CLASS DATA ========");
printTagStart(Tag.div,MaisDocContentCss.header);
printTagStart(Tag.div, MaisDocContentCss.header);
if (subTitle != null) {
printTagStart(Tag.div,MaisDocContentCss.subTitle);
printTagStart(Tag.div, MaisDocContentCss.subTitle);
printCharacters(subTitle);
printTagEnd(Tag.div);
}
printTagCharacters(titleTag, title, "title");
printTagEnd(Tag.div);
}
public void docPageClassEnd() throws IOException {
printComment("======== END OF CLASS DATA ========");
}
public ContentCloseable docPageContent() throws IOException {
docPageContentStart();
return () -> docPageContentEnd();
}
public void docPageContentStart() throws IOException {
printTagStart(Tag.div,MaisDocContentCss.contentContainer);
printTagStart(Tag.div, MaisDocContentCss.contentContainer);
}
public void docPageContentEnd() throws IOException {
printTagEnd(Tag.div);
}
public void docPageBlockStart(String title, String namedLink, String comment) throws IOException {
if (comment != null) {
printComment(comment);
@ -169,32 +177,32 @@ public class MaisDocContentWriter extends SAX3WriterHtml {
printHrefNamed(namedLink);
printTagCharacters(Tag.h3, title);
}
public void docPageBlockStart() throws IOException {
printTagStart(Tag.ul,MaisDocContentCss.blockList);
printTagStart(Tag.li,MaisDocContentCss.blockList);
printTagStart(Tag.ul, MaisDocContentCss.blockList);
printTagStart(Tag.li, MaisDocContentCss.blockList);
}
public void docPageBlockEnd() throws IOException {
printTagEnd(Tag.li);
printTagEnd(Tag.ul);
}
public void docPageBlockNext() throws IOException {
printTagEnd(Tag.li);
printTagStart(Tag.li,MaisDocContentCss.blockList);
printTagStart(Tag.li, MaisDocContentCss.blockList);
}
public ContentCloseable docTable(String tableTitle, String tableDescription, MaisDocContentCss tableCss) throws IOException {
docTableStart(tableTitle, tableDescription, tableCss);
return () -> docTableEnd();
}
public void docTableStart(String tableTitle, String tableDescription, MaisDocContentCss tableCss) throws IOException {
isRowAlt = false;
AttributesImpl atts = new AttributesImpl();
if (tableCss != null) {
atts.addAttribute ("", "class", "", "", tableCss.name());
atts.addAttribute("", "class", "", "", tableCss.name());
}
atts.addAttribute("", "border", "", "", "0");
atts.addAttribute("", "cellpadding", "", "", "3");
@ -202,18 +210,20 @@ public class MaisDocContentWriter extends SAX3WriterHtml {
if (tableDescription != null) {
atts.addAttribute("", "summary", "", "", tableDescription);
}
printTagStart(Tag.table,atts);
printTagStart(Tag.table, atts);
//@formatter:off
printTagStart(Tag.caption);
printTagStart(Tag.span);printCharacters(tableTitle);printTagEnd(Tag.span);
printTagStart(Tag.span,MaisDocContentCss.tabEnd);printCharacters("&nbsp;");printTagEnd(Tag.span);
printTagEnd(Tag.caption);
//@formatter:on
}
public void docTableEnd() throws IOException {
printTagEnd(Tag.table);
}
public void docTableHeader(String titleFirst, String titleLast) throws IOException {
printTagStart(Tag.tr);
AttributesImpl atts = new AttributesImpl();
@ -223,7 +233,7 @@ public class MaisDocContentWriter extends SAX3WriterHtml {
atts.addAttribute("", "class", "", "", MaisDocContentCss.colFirst.name());
}
atts.addAttribute("", "scope", "", "", "col");
printTagStart(Tag.th,atts);
printTagStart(Tag.th, atts);
printCharacters(titleFirst);
printTagEnd(Tag.th);
if (titleLast == null) {
@ -233,49 +243,50 @@ public class MaisDocContentWriter extends SAX3WriterHtml {
atts = new AttributesImpl();
atts.addAttribute("", "class", "", "", MaisDocContentCss.colLast.name());
atts.addAttribute("", "scope", "", "", "col");
printTagStart(Tag.th,atts);
printTagStart(Tag.th, atts);
printCharacters(titleLast);
printTagEnd(Tag.th);
printTagEnd(Tag.tr);
}
public void docTableRowLink(String dataFirstHref, String dataFirst, String dataLast) throws IOException {
docTableRowHref(dataFirstHref, dataFirst, dataLast, null, false, false, false);
}
public void docTableRow(String dataFirst, String dataLast) throws IOException {
docTableRow(dataFirst, dataLast, null);
}
public void docTableRow(String dataFirst, String dataLast, String dataBlock) throws IOException {
docTableRowHref(null, dataFirst, dataLast, dataBlock, false, false, false);
}
public void docTableRowLastStart(String dataFirst, String dataFirstHref) throws IOException {
docTableRowHref(dataFirstHref, dataFirst, null, null, false, false, true);
}
public void docTableRowLastEnd() throws IOException {
printTagEnd(Tag.td);
printTagEnd(Tag.tr);
}
public ContentCloseable docTableRow() throws IOException {
if (isRowAlt) {
printTagStart(Tag.tr,MaisDocContentCss.altColor);
printTagStart(Tag.tr, MaisDocContentCss.altColor);
} else {
printTagStart(Tag.tr,MaisDocContentCss.rowColor);
printTagStart(Tag.tr, MaisDocContentCss.rowColor);
}
isRowAlt = !isRowAlt;
return () -> printTagEnd(Tag.tr);
}
private void docTableRowHref(String dataFirstHref, String dataFirst, String dataLast, String dataBlock, boolean dataFirstCode, boolean dataLastCode, boolean skipLast) throws IOException {
private void docTableRowHref(String dataFirstHref, String dataFirst, String dataLast, String dataBlock, boolean dataFirstCode, boolean dataLastCode,
boolean skipLast) throws IOException {
Closeable tableRow = docTableRow();
if (dataLast == null) {
printTagStart(Tag.td,MaisDocContentCss.colOne);
printTagStart(Tag.td, MaisDocContentCss.colOne);
} else {
printTagStart(Tag.td,MaisDocContentCss.colFirst);
printTagStart(Tag.td, MaisDocContentCss.colFirst);
}
if (dataFirstCode) {
printTagStart(Tag.code);
@ -289,48 +300,49 @@ public class MaisDocContentWriter extends SAX3WriterHtml {
printTagEnd(Tag.code);
}
printTagEnd(Tag.td);
if (skipLast) {
printTagStart(Tag.td,MaisDocContentCss.colLast);
printTagStart(Tag.td, MaisDocContentCss.colLast);
return;
}
if (dataLast == null) {
printTagEnd(Tag.tr);
return;
}
//@formatter:off
printTagStart(Tag.td,MaisDocContentCss.colLast);
if (dataLastCode) {
printTagStart(Tag.code);printCharacters(dataLast);printTagEnd(Tag.code);
} else {
printTagStart(Tag.div,MaisDocContentCss.block);printCharacters(dataLast);printTagEnd(Tag.div);
printTagStart(Tag.div, MaisDocContentCss.block);printCharacters(dataLast);printTagEnd(Tag.div);
}
if (dataBlock != null) {
printTagStart(Tag.div,MaisDocContentCss.block);printCharacters(dataBlock);printTagEnd(Tag.div);
printTagStart(Tag.div, MaisDocContentCss.block);printCharacters(dataBlock);printTagEnd(Tag.div);
}
printTagEnd(Tag.td);
//@formatter:on
tableRow.close();
}
static public String toSafeUri(List<String> paths) {
return toSafeUri(paths.toArray(new String[]{}));
return toSafeUri(paths.toArray(new String[] {}));
}
static public String toSafeUri(String...paths) {
static public String toSafeUri(String... paths) {
StringBuilder result = new StringBuilder(100);
for (int i = 0; i < paths.length; i++) {
String path = paths[i];
result.append(toSafeUri(path));
if (i < (paths.length -1)) {
if (i < (paths.length - 1)) {
result.append('/');
}
}
return result.toString();
}
static public String toSafeUri(String uri) {
StringBuilder buf = new StringBuilder(20);
for (char c : uri.toLowerCase().toCharArray()) { // TODO: unicode 16+ error
@ -340,13 +352,13 @@ public class MaisDocContentWriter extends SAX3WriterHtml {
if (Character.isDigit(c)) {
buf.append(c);
}
if ('.'==c) {
if ('.' == c) {
buf.append(c);
}
if ('-'==c) {
if ('-' == c) {
buf.append(c);
}
if ('_'==c) {
if ('_' == c) {
buf.append(c);
}
}

1114
nx01-x4o-maisdoc/src/main/java/org/x4o/maisdoc/flake/MaisDocGenerator.java
View file

File diff suppressed because it is too large Load diff

44
nx01-x4o-maisdoc/src/main/java/org/x4o/maisdoc/flake/MaisDocNodeDataConfiguratorBean.java
View file

@ -42,83 +42,83 @@ public class MaisDocNodeDataConfiguratorBean implements MaisDocNodeDataConfigura
private Object bean = null;
private String method = null;
private List<Class<?>> targetClasses = null;
public MaisDocNodeDataConfiguratorBean() {
targetClasses = new ArrayList<Class<?>>(5);
}
public MaisDocNodeDataConfiguratorBean(Object bean,String method,Class<?>...classes) {
public MaisDocNodeDataConfiguratorBean(Object bean, String method, Class<?>... classes) {
this();
setBean(bean);
setMethod(method);
for (Class<?> cl:classes) {
for (Class<?> cl : classes) {
addtargetClass(cl);
}
}
public static void addAnnotatedNodeDataConfigurators(MaisDoc doc,Object bean) {
if (doc==null) {
public static void addAnnotatedNodeDataConfigurators(MaisDoc doc, Object bean) {
if (doc == null) {
throw new NullPointerException("Can't add to null ApiDoc.");
}
if (bean==null) {
if (bean == null) {
throw new NullPointerException("Can't scan null bean.");
}
for (Method method:bean.getClass().getMethods()) {
for (Method method : bean.getClass().getMethods()) {
MaisDocNodeDataConfiguratorMethod ammo = method.getAnnotation(MaisDocNodeDataConfiguratorMethod.class);
if (ammo==null) {
if (ammo == null) {
continue;
}
if (ammo.targetClasses().length==0) {
if (ammo.targetClasses().length == 0) {
throw new IllegalArgumentException("Can't configure writer bean with empty 'targetClasses' parameter.");
}
MaisDocNodeDataConfiguratorBean methodConfig = new MaisDocNodeDataConfiguratorBean(bean, method.getName(), ammo.targetClasses());
doc.addDataConfigurator(methodConfig);
}
}
public void configNodeData(MaisDoc doc, MaisDocNode node,MaisDocNodeData data) {
public void configNodeData(MaisDoc doc, MaisDocNode node, MaisDocNodeData data) {
Class<?> beanClass = getBean().getClass();
try {
Method methodBean = beanClass.getMethod(getMethod(), new Class[]{MaisDoc.class,MaisDocNode.class,MaisDocNodeData.class});
methodBean.invoke(getBean(), new Object[]{doc,node,data});
Method methodBean = beanClass.getMethod(getMethod(), new Class[] { MaisDoc.class, MaisDocNode.class, MaisDocNodeData.class });
methodBean.invoke(getBean(), new Object[] { doc, node, data });
} catch (Exception e) {
throw new IllegalStateException(e);
}
}
public void addtargetClass(Class<?> targetClass) {
targetClasses.add(targetClass);
}
public void removetargetClass(Class<?> targetClass) {
targetClasses.remove(targetClass);
}
public List<Class<?>> getTargetClasses() {
return targetClasses;
}
/**
* @return the bean
*/
public Object getBean() {
return bean;
}
/**
* @param bean the bean to set
*/
public void setBean(Object bean) {
this.bean = bean;
}
/**
* @return the method
*/
public String getMethod() {
return method;
}
/**
* @param method the method to set
*/

4
nx01-x4o-maisdoc/src/main/java/org/x4o/maisdoc/flake/MaisDocNodeDataConfiguratorMethod.java
View file

@ -34,8 +34,8 @@ import java.lang.annotation.Target;
* @version 1.0 Aug 11, 2013
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
@Target({ ElementType.METHOD })
public @interface MaisDocNodeDataConfiguratorMethod {
Class<?>[] targetClasses();
}

69
nx01-x4o-maisdoc/src/main/java/org/x4o/maisdoc/flake/MaisDocNodeWriterBean.java
View file

@ -48,154 +48,155 @@ public class MaisDocNodeWriterBean implements MaisDocNodeWriter {
private List<Class<?>> targetClasses = null;
private String contentGroup = null;
private String contentGroupType = null;
public MaisDocNodeWriterBean() {
targetClasses = new ArrayList<Class<?>>(5);
}
public MaisDocNodeWriterBean(MaisDocNodeBody nodeBody,Object bean,String method,Class<?>...classes) {
public MaisDocNodeWriterBean(MaisDocNodeBody nodeBody, Object bean, String method, Class<?>... classes) {
this();
setNodeBody(nodeBody);
setBean(bean);
setMethod(method);
for (Class<?> cl:classes) {
for (Class<?> cl : classes) {
addtargetClass(cl);
}
}
public static void addAnnotatedNodeContentWriters(MaisDoc doc,Object bean) {
if (doc==null) {
public static void addAnnotatedNodeContentWriters(MaisDoc doc, Object bean) {
if (doc == null) {
throw new NullPointerException("Can't add to null ApiDoc.");
}
if (bean==null) {
if (bean == null) {
throw new NullPointerException("Can't scan null bean.");
}
for (Method method:bean.getClass().getMethods()) {
for (Method method : bean.getClass().getMethods()) {
MaisDocNodeWriterMethod ammo = method.getAnnotation(MaisDocNodeWriterMethod.class);
if (ammo==null) {
if (ammo == null) {
continue;
}
if (ammo.targetClasses().length==0) {
if (ammo.targetClasses().length == 0) {
throw new IllegalArgumentException("Can't configure writer bean with empty 'targetClasses' parameter.");
}
if (ammo.targetClasses().length!=ammo.nodeBodyOrders().length) {
throw new IllegalArgumentException("Can't configure writer bean with non-equal array size of 'nodeBodyOrders'("+ammo.nodeBodyOrders().length+") and 'targetClasses'("+ammo.targetClasses().length+") parameters.");
if (ammo.targetClasses().length != ammo.nodeBodyOrders().length) {
throw new IllegalArgumentException("Can't configure writer bean with non-equal array size of 'nodeBodyOrders'(" + ammo.nodeBodyOrders().length
+ ") and 'targetClasses'(" + ammo.targetClasses().length + ") parameters.");
}
MaisDocNodeWriterBean methodWriter = new MaisDocNodeWriterBean(ammo.nodeBody(), bean, method.getName(), ammo.targetClasses());
List<Integer> nodeBodyOrder = new ArrayList<Integer>();
for (int order:ammo.nodeBodyOrders()) {
for (int order : ammo.nodeBodyOrders()) {
nodeBodyOrder.add(order);
}
methodWriter.setNodeBodyOrders(nodeBodyOrder);
if (ammo.contentGroup().length()>0) {
if (ammo.contentGroup().length() > 0) {
methodWriter.setContentGroup(ammo.contentGroup());
}
if (ammo.contentGroupType().length()>0) {
if (ammo.contentGroupType().length() > 0) {
methodWriter.setContentGroupType(ammo.contentGroupType());
}
doc.addNodeBodyWriter(methodWriter);
}
}
public void writeNodeContent(MaisDocWriteEvent<MaisDocNode> event) throws IOException {
Class<?> beanClass = getBean().getClass();
try {
Method methodBean = beanClass.getMethod(getMethod(), new Class[]{MaisDocWriteEvent.class});
methodBean.invoke(getBean(), new Object[]{event});
Method methodBean = beanClass.getMethod(getMethod(), new Class[] { MaisDocWriteEvent.class });
methodBean.invoke(getBean(), new Object[] { event });
} catch (Exception e) {
throw new IOException(e);
}
}
public void addtargetClass(Class<?> targetClass) {
targetClasses.add(targetClass);
}
public void removetargetClass(Class<?> targetClass) {
targetClasses.remove(targetClass);
}
public List<Class<?>> getTargetClasses() {
return targetClasses;
}
/**
* @return the nodeBody
*/
public MaisDocNodeBody getNodeBody() {
return nodeBody;
}
/**
* @param nodeBody the nodeBody to set
*/
public void setNodeBody(MaisDocNodeBody nodeBody) {
this.nodeBody = nodeBody;
}
/**
* @return the bean
*/
public Object getBean() {
return bean;
}
/**
* @param bean the bean to set
*/
public void setBean(Object bean) {
this.bean = bean;
}
/**
* @return the method
*/
public String getMethod() {
return method;
}
/**
* @param method the method to set
*/
public void setMethod(String method) {
this.method = method;
}
/**
* @return the nodeBodyOrders
*/
public List<Integer> getNodeBodyOrders() {
return nodeBodyOrders;
}
/**
* @param nodeBodyOrders the nodeBodyOrders to set
*/
public void setNodeBodyOrders(List<Integer> nodeBodyOrders) {
this.nodeBodyOrders = nodeBodyOrders;
}
/**
* @return the contentGroup
*/
public String getContentGroup() {
return contentGroup;
}
/**
* @param contentGroup the contentGroup to set
*/
public void setContentGroup(String contentGroup) {
this.contentGroup = contentGroup;
}
/**
* @return the contentGroupType
*/
public String getContentGroupType() {
return contentGroupType;
}
/**
* @param contentGroupType the contentGroupType to set
*/

14
nx01-x4o-maisdoc/src/main/java/org/x4o/maisdoc/flake/MaisDocNodeWriterMethod.java
View file

@ -36,16 +36,16 @@ import org.x4o.maisdoc.model.MaisDocNodeBody;
* @version 1.0 May 19, 2013
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
@Target({ ElementType.METHOD })
public @interface MaisDocNodeWriterMethod {
Class<?>[] targetClasses();
MaisDocNodeBody nodeBody();
int[] nodeBodyOrders() default {-1};
int[] nodeBodyOrders() default { -1 };
String contentGroup() default "";
String contentGroupType() default "";
}

288
nx01-x4o-maisdoc/src/main/java/org/x4o/maisdoc/model/MaisDoc.java
View file

@ -75,10 +75,10 @@ public class MaisDoc {
private boolean skipRootTreePathNode = true;
private boolean printConceptTitle = true;
private boolean printConceptPrevNext = true;
private Map<String,String> groupTypeNames = null;
private Map<String,Integer> groupTypeOrder = null;
private Map<String, String> groupTypeNames = null;
private Map<String, Integer> groupTypeOrder = null;
private String docPageSubTitle = null;
public MaisDoc() {
nodeBodyWriters = new ArrayList<MaisDocNodeWriter>(20);
concepts = new ArrayList<MaisDocConcept>(10);
@ -89,69 +89,69 @@ public class MaisDoc {
dataConfigurators = new ArrayList<MaisDocNodeDataConfigurator>(5);
annotatedClasses = new ArrayList<Class<?>>(5);
remoteClasses = new ArrayList<MaisDocRemoteClass>(5);
groupTypeNames = new HashMap<String,String>(3);
groupTypeOrder = new HashMap<String,Integer>(3);
groupTypeNames = new HashMap<String, String>(3);
groupTypeOrder = new HashMap<String, Integer>(3);
}
public void checkModel() throws NullPointerException,IllegalArgumentException {
checkNull(name,"name");
checkNull(description,"description");
checkNull(docAbout,"docAbout");
checkNull(docCopyright,"docCopyright");
checkNull(rootNode,"rootNode");
checkNull(frameNavConceptClass,"frameNavConceptClass");
checkNull(noFrameAllName,"noFrameAllName");
public void checkModel() throws NullPointerException, IllegalArgumentException {
checkNull(name, "name");
checkNull(description, "description");
checkNull(docAbout, "docAbout");
checkNull(docCopyright, "docCopyright");
checkNull(rootNode, "rootNode");
checkNull(frameNavConceptClass, "frameNavConceptClass");
checkNull(noFrameAllName, "noFrameAllName");
if (concepts.isEmpty()) {
throw new IllegalStateException("Can't work with empty concepts");
}
if (frameNavOverviewPrintParent==null) {
if (frameNavOverviewPrintParent == null) {
setFrameNavOverviewPrintParent(false);
}
if (frameNavPrintParent==null) {
if (frameNavPrintParent == null) {
setFrameNavPrintParent(false);
}
if (frameNavPrintParentParent==null) {
if (frameNavPrintParentParent == null) {
setFrameNavPrintParentParent(false);
}
if (frameNavPrintParentId==null) {
if (frameNavPrintParentId == null) {
setFrameNavPrintParentId(false);
}
if (metaStyleSheetThema==null) {
if (metaStyleSheetThema == null) {
setMetaStyleSheetThema("jdk7");
}
if (noFrameAllTopJS==null) {
noFrameAllTopJS = "\nallClassesLink = document.getElementById(\"allclasses_navbar_top\");\n"+
"if(window==top) {\n\tallClassesLink.style.display = \"block\";\n} else {\n\tallClassesLink.style.display = \"none\";\n}\n";
if (noFrameAllTopJS == null) {
noFrameAllTopJS = "\nallClassesLink = document.getElementById(\"allclasses_navbar_top\");\n"
+ "if(window==top) {\n\tallClassesLink.style.display = \"block\";\n} else {\n\tallClassesLink.style.display = \"none\";\n}\n";
}
if (noFrameAllBottomJS==null) {
noFrameAllBottomJS = "\nallClassesLink = document.getElementById(\"allclasses_navbar_bottom\");\n"+
"if(window==top) {\n\tallClassesLink.style.display = \"block\";\n} else {\n\tallClassesLink.style.display = \"none\";\n}\n";
if (noFrameAllBottomJS == null) {
noFrameAllBottomJS = "\nallClassesLink = document.getElementById(\"allclasses_navbar_bottom\");\n"
+ "if(window==top) {\n\tallClassesLink.style.display = \"block\";\n} else {\n\tallClassesLink.style.display = \"none\";\n}\n";
}
if (noFrameAllLink==null) {
if (noFrameAllLink == null) {
MaisDocConcept navConcept = findConceptByClass(getFrameNavConceptClass());
setNoFrameAllLink("all"+navConcept.getId()+"-noframe.html");
setNoFrameAllLink("all" + navConcept.getId() + "-noframe.html");
}
fillRuntimeData();
if (nodeBodyWriters.isEmpty()) {
fillOnce = false;
dataConfigurators.clear();
throw new IllegalStateException("Can't work with empty nodeBodyWriters");
}
}
private void fillRuntimeData() {
if (fillOnce) {
return;
}
setNodeData(new MaisDocNodeData());
try {
for (Class<?> annoClass:getAnnotatedClasses()) {
for (Class<?> annoClass : getAnnotatedClasses()) {
Object bean = annoClass.newInstance();
MaisDocNodeWriterBean.addAnnotatedNodeContentWriters(this,bean);
MaisDocNodeWriterBean.addAnnotatedNodeContentWriters(this, bean);
MaisDocNodeDataConfiguratorBean.addAnnotatedNodeDataConfigurators(this, bean);
}
} catch (InstantiationException e) {
@ -159,50 +159,50 @@ public class MaisDoc {
} catch (IllegalAccessException e) {
throw new IllegalArgumentException(e);
}
for (MaisDocConcept concept:getConcepts()) {
String navLink = "overview-"+concept.getId()+".html";
for (MaisDocConcept concept : getConcepts()) {
String navLink = "overview-" + concept.getId() + ".html";
boolean resetHref = true;
if (concept.getParent()==null) {
if (concept.getParent() == null) {
resetHref = false; // don't reset root node
} else {
navLink = null; // rest start with null href's
}
MaisDocNavLink link = new MaisDocNavLink(concept.getId(), navLink, concept.getName(),concept.getName(),resetHref);
MaisDocNavLink link = new MaisDocNavLink(concept.getId(), navLink, concept.getName(), concept.getName(), resetHref);
getNodeData().addNavLink(link);
}
for (MaisDocPage page:getDocPages()) {
String navLink = page.getId()+".html";
MaisDocNavLink link = new MaisDocNavLink(page.getId(), navLink, page.getName(),page.getName(),false);
for (MaisDocPage page : getDocPages()) {
String navLink = page.getId() + ".html";
MaisDocNavLink link = new MaisDocNavLink(page.getId(), navLink, page.getName(), page.getName(), false);
getNodeData().addNavLink(link);
}
for (MaisDocRemoteClass rc:getRemoteClasses()) {
for (MaisDocRemoteClass rc : getRemoteClasses()) {
try {
rc.parseRemotePackageList();
} catch (IOException e) {
throw new IllegalStateException("While parsing: "+rc.getDocUrl()+" got: "+e.getMessage(),e);
throw new IllegalStateException("While parsing: " + rc.getDocUrl() + " got: " + e.getMessage(), e);
}
}
fillOnce = true;
}
private void checkNull(Object obj,String objName) {
if (obj==null) {
throw new NullPointerException("Can't work with null "+objName);
private void checkNull(Object obj, String objName) {
if (obj == null) {
throw new NullPointerException("Can't work with null " + objName);
}
}
public MaisDocConcept findConceptByClass(Class<?> objClass) {
for (MaisDocConcept concept:getConcepts()) {
for (MaisDocConcept concept : getConcepts()) {
if (concept.getConceptClass().isAssignableFrom(objClass)) {
return concept;
}
// NOTE: only 2 level search for sub child concepts
for (MaisDocConcept c:concept.getChildConcepts()) {
for (MaisDocConcept c : concept.getChildConcepts()) {
if (c.getConceptClass().isAssignableFrom(objClass)) {
//return concept;
// return concept;
return c;
}
for (MaisDocConcept cc:c.getChildConcepts()) {
for (MaisDocConcept cc : c.getChildConcepts()) {
if (cc.getConceptClass().isAssignableFrom(objClass)) {
return cc;
}
@ -211,163 +211,153 @@ public class MaisDoc {
}
return null;
}
public MaisDocConcept findConceptChildByNode(MaisDocNode node) {
Class<?> objClass = node.getUserData().getClass();
return findConceptByClass(objClass);
/*
Class<?> parentClass = null;
if (node.getParent()!=null) {
parentClass = node.getParent().getUserData().getClass();
}
for (MaisDocConcept concept:getConcepts()) {
if (parentClass!=null && concept.getConceptClass().isAssignableFrom(parentClass)==false) {
continue;
}
for (MaisDocConcept c:concept.getChildConcepts()) {
if (c.getConceptClass().isAssignableFrom(objClass)) {
return c;
}
}
}
return null;
*/
* Class<?> parentClass = null; if (node.getParent()!=null) { parentClass = node.getParent().getUserData().getClass(); } for (MaisDocConcept
* concept:getConcepts()) { if (parentClass!=null && concept.getConceptClass().isAssignableFrom(parentClass)==false) { continue; } for (MaisDocConcept
* c:concept.getChildConcepts()) { if (c.getConceptClass().isAssignableFrom(objClass)) { return c; } } } return null;
*/
}
public List<MaisDocRemoteClass> getRemoteClasses() {
return remoteClasses;
}
public void addRemoteClass(MaisDocRemoteClass remoteClass) {
remoteClasses.add(remoteClass);
}
public void removeRemoteClass(MaisDocRemoteClass remoteClass) {
remoteClasses.add(remoteClass);
}
public List<Class<?>> getAnnotatedClasses() {
return annotatedClasses;
}
public void removeAnnotatedClasses(Class<?> annotatedClass) {
annotatedClasses.remove(annotatedClass);
}
public void addAnnotatedClasses(Class<?> annotatedClass) {
annotatedClasses.add(annotatedClass);
}
public List<MaisDocNodeDataConfigurator> getDataConfigurators() {
return dataConfigurators;
}
public void removeDataConfigurator(MaisDocNodeDataConfigurator conf) {
dataConfigurators.remove(conf);
}
public void addDataConfigurator(MaisDocNodeDataConfigurator conf) {
dataConfigurators.add(conf);
}
public MaisDocNodeWriter addNodeBodyWriter(MaisDocNodeWriter writer) {
nodeBodyWriters.add(writer);
return writer;
}
public boolean removeNodeBodyWriter(MaisDocNodeWriter writer) {
return nodeBodyWriters.remove(writer);
}
public List<MaisDocNodeWriter> getNodeBodyWriters() {
return nodeBodyWriters;
}
public MaisDocConcept addConcept(MaisDocConcept concept) {
concepts.add(concept);
return concept;
}
public boolean removeConcept(MaisDocConcept concept) {
return concepts.remove(concept);
}
public List<MaisDocConcept> getConcepts() {
return concepts;
}
public void addMetaKeyword(String keyword) {
metaKeywords.add(keyword);
}
public void addMetaKeywordAll(Collection<String> keywords) {
metaKeywords.addAll(keywords);
}
public boolean removeMetaKeyword(String keyword) {
return metaKeywords.remove(keyword);
}
public List<String> getDocKeywords() {
return metaKeywords;
}
/**
* @return the metaStyleSheet
*/
public File getMetaStyleSheet() {
return metaStyleSheet;
}
/**
* @param metaStyleSheet the metaStyleSheet to set
*/
public void setMetaStyleSheet(File metaStyleSheet) {
this.metaStyleSheet = metaStyleSheet;
}
/**
* @return the metaStyleSheetThema
*/
public String getMetaStyleSheetThema() {
return metaStyleSheetThema;
}
/**
* @param metaStyleSheetThema the metaStyleSheetThema to set
*/
public void setMetaStyleSheetThema(String metaStyleSheetThema) {
this.metaStyleSheetThema = metaStyleSheetThema;
}
/**
* @return the docCopyright
*/
public String getDocCopyright() {
return docCopyright;
}
/**
* @param docCopyright the docCopyright to set
*/
public void setDocCopyright(String docCopyright) {
this.docCopyright = docCopyright;
}
/**
* Creates default copyright message for owner.
* @param owner The owner of the copyright.
*
* @param owner The owner of the copyright.
*/
public void createDocCopyright(String owner) {
Calendar calendar = Calendar.getInstance();
String year = Integer.toString(calendar.get(Calendar.YEAR));
createDocCopyright(owner, year);
}
/**
* Creates default copyright message for owner and year.
* @param owner The owner of the copyright.
* @param year The year of the copyright.
*
* @param owner The owner of the copyright.
* @param year The year of the copyright.
*/
public void createDocCopyright(String owner, String year) {
StringBuilder buf = new StringBuilder(100);
@ -379,219 +369,219 @@ public class MaisDoc {
buf.append("All Rights Reserved.");
setDocCopyright(buf.toString());
}
/**
* @return the docAbout
*/
public String getDocAbout() {
return docAbout;
}
/**
* @param docAbout the docAbout to set
*/
public void setDocAbout(String docAbout) {
this.docAbout = docAbout;
}
public MaisDocPage addDocPage(MaisDocPage page) {
docPages.add(page);
return page;
}
public boolean removeDocPage(MaisDocPage page) {
return docPages.remove(page);
}
public List<MaisDocPage> getDocPages() {
return docPages;
}
public MaisDocPage findDocPageById(String docPageId) {
if (docPageId==null) {
if (docPageId == null) {
throw new NullPointerException("Can't search for null id.");
}
for (MaisDocPage page:docPages) {
for (MaisDocPage page : docPages) {
if (page.getId().equals(docPageId)) {
return page;
}
}
return null;
}
public Class<?> addTreeNodeClassExclude(Class<?> excludeClass) {
treeNodeClassExcludes.add(excludeClass);
return excludeClass;
}
public boolean removeTreeNodeClassExclude(Class<?> excludeClass) {
return treeNodeClassExcludes.remove(excludeClass);
}
public List<Class<?>> getTreeNodeClassExcludes() {
return treeNodeClassExcludes;
}
public Class<?> addTreeNodePageModeClass(Class<?> pageModeClass) {
treeNodePageModeClass.add(pageModeClass);
return pageModeClass;
}
public boolean removeTreeNodePageModeClass(Class<?> pageModeClass) {
return treeNodePageModeClass.remove(pageModeClass);
}
public List<Class<?>> getTreeNodePageModeClasses() {
return treeNodePageModeClass;
}
/**
* @return the name
*/
public String getName() {
return name;
}
/**
* @param name the name to set
*/
public void setName(String name) {
this.name = name;
}
/**
* @return the description
*/
public String getDescription() {
return description;
}
/**
* @param description the description to set
*/
public void setDescription(String description) {
this.description = description;
}
/**
* @return the rootNodeTreePage
*/
public MaisDocNode getRootNodeTreePage() {
return rootNodeTreePage;
}
/**
* @param rootNodeTreePage the rootNodeTreePage to set
*/
public void setRootNodeTreePage(MaisDocNode rootNodeTreePage) {
this.rootNodeTreePage = rootNodeTreePage;
}
/**
* @return the rootNode
*/
public MaisDocNode getRootNode() {
return rootNode;
}
/**
* @param rootNode the rootNode to set
*/
public void setRootNode(MaisDocNode rootNode) {
this.rootNode = rootNode;
}
/**
* @return the frameNavConceptClass
*/
public Class<?> getFrameNavConceptClass() {
return frameNavConceptClass;
}
/**
* @param frameNavConceptClass the frameNavConceptClass to set
*/
public void setFrameNavConceptClass(Class<?> frameNavConceptClass) {
this.frameNavConceptClass = frameNavConceptClass;
}
/**
* @return the frameNavPrintParent
*/
public Boolean getFrameNavPrintParent() {
return frameNavPrintParent;
}
/**
* @param frameNavPrintParent the frameNavPrintParent to set
*/
public void setFrameNavPrintParent(Boolean frameNavPrintParent) {
this.frameNavPrintParent = frameNavPrintParent;
}
/**
* @return the frameNavPrintParentParent
*/
public Boolean getFrameNavPrintParentParent() {
return frameNavPrintParentParent;
}
/**
* @param frameNavPrintParentParent the frameNavPrintParentParent to set
*/
public void setFrameNavPrintParentParent(Boolean frameNavPrintParentParent) {
this.frameNavPrintParentParent = frameNavPrintParentParent;
}
/**
* @return the frameNavOverviewPrintParent
*/
public Boolean getFrameNavOverviewPrintParent() {
return frameNavOverviewPrintParent;
}
/**
* @param frameNavOverviewPrintParent the frameNavOverviewPrintParent to set
*/
public void setFrameNavOverviewPrintParent(Boolean frameNavOverviewPrintParent) {
this.frameNavOverviewPrintParent = frameNavOverviewPrintParent;
}
/**
* @return the frameNavPrintParentId
*/
public Boolean getFrameNavPrintParentId() {
return frameNavPrintParentId;
}
/**
* @param frameNavPrintParentId the frameNavPrintParentId to set
*/
public void setFrameNavPrintParentId(Boolean frameNavPrintParentId) {
this.frameNavPrintParentId = frameNavPrintParentId;
}
/**
* @return the nodeData
*/
public MaisDocNodeData getNodeData() {
return nodeData;
}
/**
* @param nodeData the nodeData to set
*/
public void setNodeData(MaisDocNodeData nodeData) {
this.nodeData = nodeData;
}
/**
* @return the docStatsJS
*/
public String getDocStatsJS() {
return docStatsJS;
}
/**
* @param docStatsJS the docStatsJS to set
*/
@ -668,64 +658,64 @@ public class MaisDoc {
public void setSkipRootTreePathNode(boolean skipRootTreePathNode) {
this.skipRootTreePathNode = skipRootTreePathNode;
}
/**
* @return the printConceptTitle
*/
public boolean isPrintConceptTitle() {
return printConceptTitle;
}
/**
* @param printConceptTitle the printConceptTitle to set
*/
public void setPrintConceptTitle(boolean printConceptTitle) {
this.printConceptTitle = printConceptTitle;
}
/**
* @return the printConceptPrevNext
*/
public boolean isPrintConceptPrevNext() {
return printConceptPrevNext;
}
/**
* @param printConceptPrevNext the printConceptPrevNext to set
*/
public void setPrintConceptPrevNext(boolean printConceptPrevNext) {
this.printConceptPrevNext = printConceptPrevNext;
}
public List<String> getGroupTypesOrdered() {
Map<Integer,String> orderedMap = new TreeMap<Integer,String>();
for (String key:groupTypeOrder.keySet()) {
Map<Integer, String> orderedMap = new TreeMap<Integer, String>();
for (String key : groupTypeOrder.keySet()) {
Integer order = groupTypeOrder.get(key);
orderedMap.put(order, key);
}
return new ArrayList<String>(orderedMap.values());
}
public String getGroupTypeName(String groupTypeKey) {
String result = groupTypeNames.get(groupTypeKey);
if (result==null) {
if (result == null) {
result = groupTypeKey;
}
return result;
}
public void setGroupTypeName(String groupTypeKey,String name,int order) {
groupTypeNames.put(groupTypeKey,name);
public void setGroupTypeName(String groupTypeKey, String name, int order) {
groupTypeNames.put(groupTypeKey, name);
groupTypeOrder.put(groupTypeKey, order);
}
/**
* @return the docPageSubTitle
*/
public String getDocPageSubTitle() {
return docPageSubTitle;
}
/**
* @param docPageSubTitle the docPageSubTitle to set
*/

48
nx01-x4o-maisdoc/src/main/java/org/x4o/maisdoc/model/MaisDocConcept.java
View file

@ -40,107 +40,107 @@ public class MaisDocConcept {
private MaisDocConcept parent = null;
private Class<?> conceptClass = null;
private List<MaisDocConcept> childConcepts = null;
public MaisDocConcept() {
childConcepts = new ArrayList<MaisDocConcept>(5);
}
public MaisDocConcept(MaisDocConcept parent,String id,Class<?> conceptClass) {
public MaisDocConcept(MaisDocConcept parent, String id, Class<?> conceptClass) {
this();
setId(id);
setConceptClass(conceptClass);
setParent(parent);
}
public MaisDocConcept(MaisDocConcept parent,String[] text,Class<?> conceptClass) {
this(parent,text[0],text[1],text[2],text[3],conceptClass);
public MaisDocConcept(MaisDocConcept parent, String[] text, Class<?> conceptClass) {
this(parent, text[0], text[1], text[2], text[3], conceptClass);
}
public MaisDocConcept(MaisDocConcept parent,String id,String name,String descriptionName,String descriptionHelp,Class<?> conceptClass) {
this(parent,id,conceptClass);
public MaisDocConcept(MaisDocConcept parent, String id, String name, String descriptionName, String descriptionHelp, Class<?> conceptClass) {
this(parent, id, conceptClass);
setName(name);
setDescriptionName(descriptionName);
setDescriptionHelp(descriptionHelp);
}
/**
* @return the id
*/
public String getId() {
return id;
}
/**
* @param id the id to set
*/
public void setId(String id) {
this.id = id;
}
/**
* @return the name
*/
public String getName() {
return name;
}
/**
* @param name the name to set
*/
public void setName(String name) {
this.name = name;
}
/**
* @return the descriptionName
*/
public String getDescriptionName() {
return descriptionName;
}
/**
* @param descriptionName the descriptionName to set
*/
public void setDescriptionName(String descriptionName) {
this.descriptionName = descriptionName;
}
/**
* @return the descriptionHelp
*/
public String getDescriptionHelp() {
return descriptionHelp;
}
/**
* @param descriptionHelp the descriptionHelp to set
*/
public void setDescriptionHelp(String descriptionHelp) {
this.descriptionHelp = descriptionHelp;
}
/**
* @return the conceptClass
*/
public Class<?> getConceptClass() {
return conceptClass;
}
/**
* @param conceptClass the conceptClass to set
*/
public void setConceptClass(Class<?> conceptClass) {
this.conceptClass = conceptClass;
}
public void addChildConcept(MaisDocConcept childConcept) {
childConcepts.add(childConcept);
}
public void removeChildConcept(MaisDocConcept childConcept) {
childConcepts.remove(childConcept);
}
public List<MaisDocConcept> getChildConcepts() {
return childConcepts;
}
@ -158,7 +158,5 @@ public class MaisDocConcept {
public void setParent(MaisDocConcept parent) {
this.parent = parent;
}
}
}

28
nx01-x4o-maisdoc/src/main/java/org/x4o/maisdoc/model/MaisDocIndexItem.java
View file

@ -34,90 +34,90 @@ public class MaisDocIndexItem {
private String linkText = null;
private String titlePostHref = null;
private String titlePostText = null;
private String title = null;
private String description = null;
public MaisDocIndexItem() {
}
/**
* @return the linkHref
*/
public String getLinkHref() {
return linkHref;
}
/**
* @param linkHref the linkHref to set
*/
public void setLinkHref(String linkHref) {
this.linkHref = linkHref;
}
/**
* @return the linkText
*/
public String getLinkText() {
return linkText;
}
/**
* @param linkText the linkText to set
*/
public void setLinkText(String linkText) {
this.linkText = linkText;
}
/**
* @return the titlePostHref
*/
public String getTitlePostHref() {
return titlePostHref;
}
/**
* @param titlePostHref the titlePostHref to set
*/
public void setTitlePostHref(String titlePostHref) {
this.titlePostHref = titlePostHref;
}
/**
* @return the titlePostText
*/
public String getTitlePostText() {
return titlePostText;
}
/**
* @param titlePostText the titlePostText to set
*/
public void setTitlePostText(String titlePostText) {
this.titlePostText = titlePostText;
}
/**
* @return the title
*/
public String getTitle() {
return title;
}
/**
* @param title the title to set
*/
public void setTitle(String title) {
this.title = title;
}
/**
* @return the description
*/
public String getDescription() {
return description;
}
/**
* @param description the description to set
*/

26
nx01-x4o-maisdoc/src/main/java/org/x4o/maisdoc/model/MaisDocNavLink.java
View file

@ -35,81 +35,81 @@ public class MaisDocNavLink {
private String title = null;
private String text = null;
private boolean resetHref = false;
public MaisDocNavLink() {
}
public MaisDocNavLink(String id,String href,String title,String text,boolean resetHref) {
public MaisDocNavLink(String id, String href, String title, String text, boolean resetHref) {
setId(id);
setHref(href);
setTitle(title);
setText(text);
setResetHref(resetHref);
}
/**
* @return the id
*/
public String getId() {
return id;
}
/**
* @param id the id to set
*/
public void setId(String id) {
this.id = id;
}
/**
* @return the href
*/
public String getHref() {
return href;
}
/**
* @param href the href to set
*/
public void setHref(String href) {
this.href = href;
}
/**
* @return the title
*/
public String getTitle() {
return title;
}
/**
* @param title the title to set
*/
public void setTitle(String title) {
this.title = title;
}
/**
* @return the text
*/
public String getText() {
return text;
}
/**
* @param text the text to set
*/
public void setText(String text) {
this.text = text;
}
/**
* @return the resetHref
*/
public boolean isResetHref() {
return resetHref;
}
/**
* @param resetHref the resetHref to set
*/

38
nx01-x4o-maisdoc/src/main/java/org/x4o/maisdoc/model/MaisDocNode.java
View file

@ -39,104 +39,104 @@ public class MaisDocNode {
private String description = null;
private MaisDocNode parent = null;
private List<MaisDocNode> nodes = null;
public MaisDocNode() {
nodes = new ArrayList<MaisDocNode>(30);
}
public MaisDocNode(Object userData,String id,String name,String description) {
public MaisDocNode(Object userData, String id, String name, String description) {
this();
setUserData(userData);
setId(id);
setName(name);
if (description==null) {
if (description == null) {
description = name;
}
setDescription(description);
}
public MaisDocNode addNode(MaisDocNode node) {
node.setParent(this);
nodes.add(node);
return node;
}
public boolean removeNode(MaisDocNode node) {
return nodes.remove(node);
}
public List<MaisDocNode> getNodes() {
return nodes;
}
@SuppressWarnings("unchecked")
public <T> T toUserData(Class<T> type) {
return (T)getUserData();
return (T) getUserData();
}
/**
* @return the userData
*/
public Object getUserData() {
return userData;
}
/**
* @param userData the userData to set
*/
public void setUserData(Object userData) {
this.userData = userData;
}
/**
* @return the id
*/
public String getId() {
return id;
}
/**
* @param id the id to set
*/
public void setId(String id) {
this.id = id;
}
/**
* @return the name
*/
public String getName() {
return name;
}
/**
* @param name the name to set
*/
public void setName(String name) {
this.name = name;
}
/**
* @return the description
*/
public String getDescription() {
return description;
}
/**
* @param description the description to set
*/
public void setDescription(String description) {
this.description = description;
}
/**
* @return the parent
*/
public MaisDocNode getParent() {
return parent;
}
/**
* @param parent the parent to set
*/

6
nx01-x4o-maisdoc/src/main/java/org/x4o/maisdoc/model/MaisDocNodeBody.java
View file

@ -29,10 +29,12 @@ package org.x4o.maisdoc.model;
* @version 1.0 May 12, 2013
*/
public enum MaisDocNodeBody {
//@formatter:off
TREE_PATH,
DESCRIPTION_LINKS,
DESCRIPTION_NODE,
SUMMARY,
DETAIL
DETAIL,
;
//@formatter:on
}

66
nx01-x4o-maisdoc/src/main/java/org/x4o/maisdoc/model/MaisDocNodeData.java
View file

@ -38,151 +38,151 @@ public class MaisDocNodeData {
private String prefixPath;
private String navSelected = null;
private List<String> groupTypeKeys = null;
private Map<String,List<MaisDocNavLink>> groupTypeLinks = null;
private Map<String, List<MaisDocNavLink>> groupTypeLinks = null;
private String prevLink = null;
private String nextLink = null;
private String framePath = null;;
private List<MaisDocNavLink> navLinks = null;
private List<MaisDocIndexItem> indexItems = null;
public MaisDocNodeData() {
navLinks = new ArrayList<MaisDocNavLink>(12);
groupTypeKeys = new ArrayList<String>(navLinks.size()/3);
groupTypeLinks = new HashMap<String,List<MaisDocNavLink>>(groupTypeKeys.size());
groupTypeKeys = new ArrayList<String>(navLinks.size() / 3);
groupTypeLinks = new HashMap<String, List<MaisDocNavLink>>(groupTypeKeys.size());
indexItems = new ArrayList<MaisDocIndexItem>(500);
}
public List<MaisDocIndexItem> getIndexItems() {
return indexItems;
}
public void addIndexItem(MaisDocIndexItem indexItem) {
indexItems.add(indexItem);
}
public void addGroupTypeKey(String groupTypeKey) {
groupTypeKeys.add(groupTypeKey);
}
public List<String> getGroupTypeKeys() {
return groupTypeKeys;
}
public void addGroupTypeLink(String groupTypeKey,MaisDocNavLink link) {
public void addGroupTypeLink(String groupTypeKey, MaisDocNavLink link) {
List<MaisDocNavLink> result = groupTypeLinks.get(groupTypeKey);
if (result==null) {
if (result == null) {
result = new ArrayList<MaisDocNavLink>(10);
groupTypeLinks.put(groupTypeKey, result);
}
result.add(link);
}
public List<MaisDocNavLink> getGroupTypeLinks(String groupTypeKey) {
List<MaisDocNavLink> result = groupTypeLinks.get(groupTypeKey);
if (result==null) {
if (result == null) {
result = new ArrayList<MaisDocNavLink>(0);
}
return result;
}
public MaisDocNavLink getGroupTypeLink(String groupTypeKey,String group) {
public MaisDocNavLink getGroupTypeLink(String groupTypeKey, String group) {
List<MaisDocNavLink> links = getGroupTypeLinks(groupTypeKey);
for (MaisDocNavLink link:links) {
for (MaisDocNavLink link : links) {
if (link.getId().equals(group)) {
return link;
}
}
return null;
}
public void clearGroupTypeLinks() {
groupTypeLinks.clear();
groupTypeLinks.clear();
}
public List<MaisDocNavLink> getNavLinks() {
return navLinks;
}
public MaisDocNavLink getNavLinkById(String id) {
for (MaisDocNavLink link:navLinks) {
for (MaisDocNavLink link : navLinks) {
if (link.getId().equals(id)) {
return link;
}
}
return null;
}
public void addNavLink(MaisDocNavLink link) {
navLinks.add(link);
}
public void removeNavLink(MaisDocNavLink link) {
navLinks.remove(link);
}
/**
* @return the prefixPath
*/
public String getPrefixPath() {
return prefixPath;
}
/**
* @param prefixPath the prefixPath to set
*/
public void setPrefixPath(String prefixPath) {
this.prefixPath = prefixPath;
}
/**
* @return the navSelected
*/
public String getNavSelected() {
return navSelected;
}
/**
* @param navSelected the navSelected to set
*/
public void setNavSelected(String navSelected) {
this.navSelected = navSelected;
}
/**
* @return the prevLink
*/
public String getPrevLink() {
return prevLink;
}
/**
* @param prevLink the prevLink to set
*/
public void setPrevLink(String prevLink) {
this.prevLink = prevLink;
}
/**
* @return the nextLink
*/
public String getNextLink() {
return nextLink;
}
/**
* @param nextLink the nextLink to set
*/
public void setNextLink(String nextLink) {
this.nextLink = nextLink;
}
/**
* @return the framePath
*/
public String getFramePath() {
return framePath;
}
/**
* @param framePath the framePath to set
*/

6
nx01-x4o-maisdoc/src/main/java/org/x4o/maisdoc/model/MaisDocNodeDataConfigurator.java
View file

@ -31,8 +31,8 @@ import java.util.List;
* @version 1.0 Aug 11, 2013
*/
public interface MaisDocNodeDataConfigurator {
List<Class<?>> getTargetClasses();
void configNodeData(MaisDoc doc,MaisDocNode node,MaisDocNodeData data);
void configNodeData(MaisDoc doc, MaisDocNode node, MaisDocNodeData data);
}

6
nx01-x4o-maisdoc/src/main/java/org/x4o/maisdoc/model/MaisDocNodeWriter.java
View file

@ -34,10 +34,14 @@ import java.util.List;
public interface MaisDocNodeWriter {
MaisDocNodeBody getNodeBody();
List<Class<?>> getTargetClasses();
List<Integer> getNodeBodyOrders();
String getContentGroup();
String getContentGroupType();
void writeNodeContent(MaisDocWriteEvent<MaisDocNode> e) throws IOException;
}

28
nx01-x4o-maisdoc/src/main/java/org/x4o/maisdoc/model/MaisDocPage.java
View file

@ -32,82 +32,82 @@ import java.util.List;
* @version 1.0 May 12, 2013
*/
public class MaisDocPage {
private String id = null;
private String name = null;
private String description = null;
private List<MaisDocPageWriter> pageWriters = null;
public MaisDocPage() {
pageWriters = new ArrayList<MaisDocPageWriter>(30);
}
public MaisDocPage(String id,String name,String description,MaisDocPageWriter...writers) {
public MaisDocPage(String id, String name, String description, MaisDocPageWriter... writers) {
this();
setId(id);
setName(name);
setDescription(description);
for (MaisDocPageWriter writer:writers) {
for (MaisDocPageWriter writer : writers) {
addPageWriter(writer);
}
}
/**
* @return the id
*/
public String getId() {
return id;
}
/**
* @param id the id to set
*/
public void setId(String id) {
this.id = id;
}
/**
* @return the name
*/
public String getName() {
return name;
}
/**
* @param name the name to set
*/
public void setName(String name) {
this.name = name;
}
/**
* @return the description
*/
public String getDescription() {
return description;
}
/**
* @param description the description to set
*/
public void setDescription(String description) {
this.description = description;
}
/**
* @return the page writers.
*/
public List<MaisDocPageWriter> getPageWriters() {
return pageWriters;
}
/**
* @param writer the writer to add.
*/
public void addPageWriter(MaisDocPageWriter writer) {
pageWriters.add(writer);
}
/**
* @param writer the writer to add.
*/

2
nx01-x4o-maisdoc/src/main/java/org/x4o/maisdoc/model/MaisDocPageWriter.java
View file

@ -31,6 +31,6 @@ import java.io.IOException;
* @version 1.0 May 12, 2013
*/
public interface MaisDocPageWriter {
void writePageContent(MaisDocWriteEvent<MaisDocPage> e) throws IOException;
}

72
nx01-x4o-maisdoc/src/main/java/org/x4o/maisdoc/model/MaisDocRemoteClass.java
View file

@ -46,74 +46,79 @@ public class MaisDocRemoteClass {
private String docUrl = null;
private String packageListUrl = null;
private List<String> packageList = null;
/**
* Creates the ApiDocRemoteClass.
*/
private MaisDocRemoteClass() {
packageList = new ArrayList<String>(100);
}
/**
* Creates the ApiDocRemoteClass with a javadoc url to fetch the package-list from.
* @param docUrl The remote javadoc base url.
*
* @param docUrl The remote javadoc base url.
*/
public MaisDocRemoteClass(String docUrl) {
this();
setDocUrl(docUrl);
}
/**
* Creates the ApiDocRemoteClass with a javadoc url. but fetched the package-list from the packageListUrl.
* @param docUrl The remote javadoc base url.
* @param packageListUrl The remote/local package-list url.
*
* @param docUrl The remote javadoc base url.
* @param packageListUrl The remote/local package-list url.
*/
public MaisDocRemoteClass(String docUrl,String packageListUrl) {
public MaisDocRemoteClass(String docUrl, String packageListUrl) {
this(docUrl);
setPackageListUrl(packageListUrl);
}
/**
* Returns remote url for a class or null if no remote package excists for the class.
* @param cls The class to get the remote url for.
* @return The remote url of the class requested or null if none if found.
*
* @param cls The class to get the remote url for.
* @return The remote url of the class requested or null if none if found.
*/
public String getRemoteUrl(Class<?> cls) {
if (cls==null) {
if (cls == null) {
return null;
}
if (cls.isArray()) {
return null;
}
if (cls.getPackage()==null) {
if (cls.getPackage() == null) {
return null;
}
String packageName = cls.getPackage().getName();
logger.fine("Search "+packageName+" in "+packageList.size()+" of "+docUrl);
logger.fine("Search " + packageName + " in " + packageList.size() + " of " + docUrl);
if (packageList.contains(packageName)) {
String baseUrl = getDocUrlClean();
String packagePath = packageName.replaceAll("\\.", "/");
String fullUrl = baseUrl+packagePath+"/"+cls.getSimpleName()+".html";
String fullUrl = baseUrl + packagePath + "/" + cls.getSimpleName() + ".html";
return fullUrl;
}
return null;
}
/**
* Cleans the docUrl by sometimes appending postfix slash.
* @return The cleaned doc url.
* Cleans the docUrl by sometimes appending postfix slash.
*
* @return The cleaned doc url.
*/
private String getDocUrlClean() {
String baseUrl = getDocUrl();
if (baseUrl.endsWith("/")==false) {
if (baseUrl.endsWith("/") == false) {
baseUrl += "/";
}
return baseUrl;
}
/**
* Fetches and parses the package-list file.
* @throws IOException If error happend.
*
* @throws IOException If error happend.
*/
public void parseRemotePackageList() throws IOException {
packageList.clear();
@ -125,58 +130,59 @@ public class MaisDocRemoteClass {
conn.setReadTimeout(2000);
parseRemoteFile(conn.getInputStream(), conn.getContentEncoding());
}
/**
* Parsed the inputStream into the packagList values.
* @param in The inputStream.
* @param enc The encoding of the inputStream.
* @throws IOException When error on inputStream.
*
* @param in The inputStream.
* @param enc The encoding of the inputStream.
* @throws IOException When error on inputStream.
*/
private void parseRemoteFile(InputStream in,String enc) throws IOException {
if (enc==null) {
private void parseRemoteFile(InputStream in, String enc) throws IOException {
if (enc == null) {
enc = "UTF-8";
}
BufferedReader br = new BufferedReader(new InputStreamReader(in,Charset.forName(enc)));
BufferedReader br = new BufferedReader(new InputStreamReader(in, Charset.forName(enc)));
try {
String line = null;
while ((line = br.readLine()) != null) {
String lineClean = line.trim();
packageList.add(lineClean);
logger.finer("Adding remote package: '"+lineClean+"'");
logger.finer("Adding remote package: '" + lineClean + "'");
}
} finally {
br.close();
}
}
/**
* @return the docUrl
*/
public String getDocUrl() {
return docUrl;
}
/**
* @param docUrl the docUrl to set
*/
public void setDocUrl(String docUrl) {
this.docUrl = docUrl;
}
/**
* @return the packageListUrl
*/
public String getPackageListUrl() {
return packageListUrl;
}
/**
* @param packageListUrl the packageListUrl to set
*/
public void setPackageListUrl(String packageListUrl) {
this.packageListUrl = packageListUrl;
}
/**
* @return the packageList
*/

23
nx01-x4o-maisdoc/src/main/java/org/x4o/maisdoc/model/MaisDocWriteEvent.java
View file

@ -36,33 +36,34 @@ public class MaisDocWriteEvent<T> {
private MaisDoc doc = null;
private T eventObject = null;
private MaisDocContentWriter writer = null;
/**
* Creates an ApiDocNodeBodyEvent.
* @param doc The ApiDoc we are writing.
* @param writer The content writer to write to.
* @param eventObject The event we are firing this event for.
*
* @param doc The ApiDoc we are writing.
* @param writer The content writer to write to.
* @param eventObject The event we are firing this event for.
*/
public MaisDocWriteEvent(MaisDoc doc,MaisDocContentWriter writer,T eventObject) {
this.doc=doc;
this.writer=writer;
this.eventObject=eventObject;
public MaisDocWriteEvent(MaisDoc doc, MaisDocContentWriter writer, T eventObject) {
this.doc = doc;
this.writer = writer;
this.eventObject = eventObject;
}
/**
* @return the doc
*/
public MaisDoc getDoc() {
return doc;
}
/**
* @return the event
*/
public T getEventObject() {
return eventObject;
}
/**
* @return the writer
*/