1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
|
/**
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.tuscany.samples.sdo.internal;
import java.io.IOException;
import java.lang.reflect.Field;
import java.lang.reflect.InvocationTargetException;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.Map;
import java.util.Set;
import org.apache.tuscany.samples.sdo.internal.SampleInfrastructure.SDOFacets;
/**
* Class to generate html documentation for the SDO Samples.
* The program introspects the sample programs listed in the
* {@link SampleInfrastructure#sampleClasses sample classes}
* static constant, for the values of the static CORE_FUNCTION
* and SIGNIFICANT_FUNCTION variables.
* <P>
* It builds indexes from
* sample to function and from function to sample and creates
* html output that displays these indexes.
*/
public class DocumentSamples {
private Map classToCoreFunction = new HashMap();
private Map coreFunctionToClass = new HashMap();
private Map classToSignificantFunction = new HashMap();
private Map significantFunctionToClass = new HashMap();
public static void main(String[] args) throws SecurityException,
NoSuchMethodException, IllegalArgumentException, InstantiationException,
IllegalAccessException, InvocationTargetException, IOException {
DocumentSamples ds = new DocumentSamples();
ds.run();
}
private static String HTML_HEADER =
"<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\" \"http://www.w3.org/TR/html4/loose.dtd\">\n" +
"<html>\n" +
"<!-- Note: This file is GENERATED from the samples using the\n" +
"Document Samples utility. Hand edits will be lost when regenerated! --> \n"+
"<!-- \n"+
"* \n"+
"* Licensed to the Apache Software Foundation (ASF) under one \n"+
"* or more contributor license agreements. See the NOTICE file\n"+
"* distributed with this work for additional information \n"+
"* regarding copyright ownership. The ASF licenses this file \n"+
"* to you under the Apache License, Version 2.0 (the \n"+
"* \"License\"); you may not use this file except in compliance \n"+
"* with the License. You may obtain a copy of the License at \n"+
"* \n"+
"* http://www.apache.org/licenses/LICENSE-2.0 \n"+
"* \n"+
"* Unless required by applicable law or agreed to in writing, \n"+
"* software distributed under the License is distributed on an \n"+
"* \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY \n"+
"* KIND, either express or implied. See the License for the \n"+
"* specific language governing permissions and limitations \n"+
"* under the License. \n"+
"--> \n"+
"<head><title>SDO Samples</title></head><body>\n" +
" <h1>SDO Samples</h1>\n" +
"<P>\n" +
"The samples provided in the Tuscany SDO distribution cover many areas of\n" +
"the SDO API. Here we provide two indexes into the samples. The first lists\n" +
"each sample in sequence and details the central theme(s) of the sample.\n" +
"It also mentions if the sample significantly demonstrates other areas in passing.\n" +
"The second index lists all the themes that are covered by these samples, and\n" +
"indicates which of the samples has that subject area as a central theme or as\n" +
"demonstrates the subject area significant as an incidental part of the sample.";
private static String CLASSES_HEADING =
"<H2>Index by Sample Program Name</H2>\n";
private static String FUNCTION_HEADING =
"<H2>Index by function</H2>\n";
private static String HTML_FOOTER =
"</body>\n</html>";
private void run() throws IllegalAccessException {
/*
* gather the data
*/
for (int i = 0; i < SampleInfrastructure.sampleClasses.length; i++) {
Class c = SampleInfrastructure.sampleClasses[i];
classToCoreFunction.put(c, new HashSet());
try {
Field coreFunction = c.getField("CORE_FUNCTION");
recordFunction(c, coreFunction, coreFunctionToClass, classToCoreFunction);
} catch (NoSuchFieldException e) {
// no problem
}
try {
Field sigFunction = c.getField("SIGNIFICANT_FUNCTION");
recordFunction(c, sigFunction, significantFunctionToClass, classToSignificantFunction);
} catch (NoSuchFieldException e) {
// no problem
}
}
/*
* create the documentation
*/
StringBuffer doc = new StringBuffer();
doc.append(HTML_HEADER);
doc.append(CLASSES_HEADING);
Class [] classes = SampleInfrastructure.sampleClasses;
for(int i=0; i < classes.length;i++) {
doc.append("<h3>Sample Program " + getSimpleName(classes[i]) + "</h3>\n");
doc.append("<b>Core function:</b><br/>\n");
int [] functions = (int[])classToCoreFunction.get(classes[i]);
for(int j=0;j<functions.length;j++) {
doc.append("<a href=\"#facet")
.append(functions[j])
.append("\">")
.append(SDOFacets.subject_areas[functions[j]])
.append("</a><br/>\n"); }
doc.append("<br/>");
if(classToSignificantFunction.get(classes[i])!= null) {
doc.append("<b>Also demonstrates:</b><br/>\n");
functions = (int[])classToSignificantFunction.get(classes[i]);
for(int j=0;j<functions.length;j++) {
doc.append("<a href=\"#facet")
.append(functions[j])
.append("\">")
.append(SDOFacets.subject_areas[functions[j]])
.append("</a><br/>\n");
}
}
}
doc.append(FUNCTION_HEADING);
String [] facets = SDOFacets.subject_areas;
for(int f = 0; f<facets.length; f++) {
Integer fobj = new Integer(f);
doc.append("<a name=\"facet")
.append(f)
.append("\"/>\n<h3>")
.append(SDOFacets.subject_areas[f])
.append("</h3>\n");
if(coreFunctionToClass.keySet().contains(fobj)) {
doc.append("<b>Samples which demonstrate this as their core function</b><br/>\n");
Set classesWithFunction = (Set)coreFunctionToClass.get(fobj);
for(Iterator cwf = classesWithFunction.iterator(); cwf.hasNext();) {
Class c = (Class)cwf.next();
doc.append(getSimpleName(c)).append("<br/>\n");
}
}
if(significantFunctionToClass.keySet().contains(fobj)) {
doc.append("<b>Samples which demonstrate this in addition to their core function</b><br/>\n");
Set classesWithFunction = (Set)significantFunctionToClass.get(fobj);
for(Iterator cwf = classesWithFunction.iterator(); cwf.hasNext();) {
Class c = (Class)cwf.next();
doc.append(getSimpleName(c)).append("<br/>\n");
}
}
}
doc.append(HTML_FOOTER);
System.out.println(doc);
}
private int[] recordFunction(Class c, Field functionIndices, Map ftoc, Map ctof)
throws IllegalAccessException {
int[] functions = (int[]) functionIndices.get(c);
for (int j = 0; j < functions.length; j++) {
addClassesToFunction(ftoc, functions[j], c);
}
ctof.put(c, functions);
return functions;
}
private void addClassesToFunction(Map functionToClass, int i, Class c) {
Integer iobj = new Integer(i);
if (!functionToClass.containsKey(iobj)) {
functionToClass.put(iobj, new HashSet());
}
((Set) (functionToClass.get(iobj))).add(c);
}
private String getSimpleName(Class c) {
String result = c.getName();
int lastDot = result.lastIndexOf('.');
if(lastDot != -1) {
result = result.substring(lastDot+1);
}
return result;
}
}
|
