com.vectorprint.report.itext.Help Maven / Gradle / Ivy
Show all versions of ConfigurableReports Show documentation
/*
* To change this template, choose Tools | Templates
* and open the template in the editor.
*/
package com.vectorprint.report.itext;
/*
* #%L
* VectorPrintReport4.0
* %%
* Copyright (C) 2012 - 2013 VectorPrint
* %%
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see " + ReportRunner.class.getName() + " or \n");
out.println(" Settings must contain "+ReportConstants.DATACLASS+", look at "+ReportConstants.class.getName()+" for more available settings\n");
out.println(" You can look at the junit tests to see working examples\n");
out.println(" Javadoc is recommended as a source for further details\n");
out.println("Available stylers that can be configured in a settings file, together with parameters that may be used.");
out.println("---------------------------------------------------------------------------------------------------------\n");
out.println(" All parameters mentioned below can take defaults through properties in the current syntax\n"
+ "by default <(Parent)Class.getSimpleName().parameterName>=\n");
}
public static void printHelpFooter(Document document, com.itextpdf.text.Font f) throws IOException, FileNotFoundException, ClassNotFoundException, InstantiationException, IllegalAccessException, DocumentException, NoSuchMethodException, InvocationTargetException {
document.add(new Paragraph("\nAvailable conditions for stylers that can be configured in a properties file, together with parameters that may be used."
+ "---------------------------------------------------------------------------------------------------------\n"
+ " All parameters mentioned below can take defaults through properties in the form <(Parent)Class.getSimpleName().parameterName>=\n", f));
for (Class c : ClassHelper.fromPackage(RegexCondition.class.getPackage())) {
if (StylingCondition.class.isAssignableFrom(c) && !Modifier.isAbstract(c.getModifiers())) {
StylingCondition s = (StylingCondition) c.newInstance();
document.add(Chunk.NEWLINE);
document.add(new Chunk(c.getSimpleName(), f).setLocalDestination(c.getSimpleName()));
document.add(new Phrase(": " + s.getHelp() + " \n parameters available:\n", f));
ByteArrayOutputStream o = new ByteArrayOutputStream(400);
PrintStream out = new PrintStream(o);
printParamInfo(s, out);
out.flush();
document.add(new Paragraph(o.toString(), f));
}
}
}
public static void printHelpFooter(PrintStream out) throws IOException, FileNotFoundException, ClassNotFoundException, InstantiationException, IllegalAccessException, NoSuchMethodException, InvocationTargetException {
out.println("\nAvailable conditions for stylers that can be configured in a properties file, together with parameters that may be used.");
out.println("---------------------------------------------------------------------------------------------------------\n");
out.println(" All parameters mentioned below can take defaults through properties in the form <(Parent)Class.getSimpleName().parameterName>=\n");
for (Class c : ClassHelper.fromPackage(RegexCondition.class.getPackage())) {
if (StylingCondition.class.isAssignableFrom(c) && !Modifier.isAbstract(c.getModifiers())) {
StylingCondition s = (StylingCondition) c.newInstance();
out.println("\n" + c.getSimpleName() + ": " + s.getHelp() + "\n parameters available:\n");
printParamInfo(s, out);
}
}
}
public static void printStylerHelp(Document document, com.itextpdf.text.Font f) throws IOException, FileNotFoundException, ClassNotFoundException, InstantiationException, IllegalAccessException, DocumentException, NoSuchMethodException, InvocationTargetException {
for (Class c : ClassHelper.fromPackage(Font.class.getPackage())) {
if (BaseStyler.class.isAssignableFrom(c) && !Modifier.isAbstract(c.getModifiers())) {
BaseStyler s = (BaseStyler) c.newInstance();
document.add(Chunk.NEWLINE);
document.add(new Chunk(c.getSimpleName(), f).setLocalDestination(c.getSimpleName()));
document.add(new Phrase(": " + s.getHelp() + "\n parameters available:", f));
ByteArrayOutputStream o = new ByteArrayOutputStream(400);
PrintStream out = new PrintStream(o);
printParamInfo(s, out);
out.println(" able to style: " + s.getSupportedClasses());
addStylerForClass(s);
if (s.creates()) {
out.println(" creates supported Class");
}
out.flush();
document.add(new Paragraph(o.toString(), f));
}
}
printStylersPerClass(document, f);
}
private static Map>> stylersForClass = new HashMap>>(30);
private static void addStylerForClass(BaseStyler bs) {
for (Class cc : bs.getSupportedClasses()) {
if (!stylersForClass.containsKey(cc)) {
stylersForClass.put((Class) cc, new HashSet>(30));
}
stylersForClass.get(cc).add(bs.getClass());
if (Element.class.equals(cc)) {
break;
}
for (Class su : stylersForClass.keySet()) {
if (Element.class.equals(su)) {
break;
}
if (su.isAssignableFrom((Class) cc) && !su.equals(cc)) {
stylersForClass.get(cc).addAll(stylersForClass.get(su));
}
}
}
}
/**
* Calls {@link #getParameterizables(java.lang.Package, java.lang.Class) } to collect {@link BaseStyler}s and
* {@link FormFieldStyler}s.
*
* @return
* @throws IOException
* @throws FileNotFoundException
* @throws ClassNotFoundException
* @throws InstantiationException
* @throws IllegalAccessException
* @throws NoSuchMethodException
* @throws InvocationTargetException
*/
public static Set getStylers() throws IOException, FileNotFoundException, ClassNotFoundException, InstantiationException, IllegalAccessException, NoSuchMethodException, InvocationTargetException {
Set stylers = getParameterizables(AbstractStyler.class.getPackage(), BaseStyler.class);
return stylers;
}
public static Set getStylersAndConditions() throws IOException, FileNotFoundException, ClassNotFoundException, InstantiationException, IllegalAccessException, NoSuchMethodException, InvocationTargetException {
Set parameterizables = getParameterizables(AbstractCondition.class.getPackage(), Parameterizable.class);
parameterizables.addAll(getParameterizables(AbstractStyler.class.getPackage(), Parameterizable.class));
return parameterizables;
}
/**
* Use this generic method in for example a gui that supports building a styling file.
*
* @param
* @param javaPackage
* @param clazz
* @return
* @throws IOException
* @throws FileNotFoundException
* @throws ClassNotFoundException
* @throws InstantiationException
* @throws IllegalAccessException
* @throws NoSuchMethodException
* @throws InvocationTargetException
*/
public static
Set
getParameterizables(Package javaPackage, Class
clazz) throws IOException, FileNotFoundException, ClassNotFoundException, InstantiationException, IllegalAccessException, NoSuchMethodException, InvocationTargetException {
Set
parameterizables = new HashSet
(50);
for (Class c : ClassHelper.fromPackage(javaPackage)) {
if (clazz.isAssignableFrom(c) && !Modifier.isAbstract(c.getModifiers())) {
parameterizables.add((P) c.newInstance());
}
}
return parameterizables;
}
public static void printStylerHelp(PrintStream out) throws IOException, FileNotFoundException, ClassNotFoundException, InstantiationException, IllegalAccessException, NoSuchMethodException, InvocationTargetException {
for (Class c : ClassHelper.fromPackage(Font.class.getPackage())) {
if (BaseStyler.class.isAssignableFrom(c) && !Modifier.isAbstract(c.getModifiers())) {
BaseStyler s = (BaseStyler) c.newInstance();
out.println("\n" + c.getSimpleName() + ": " + s.getHelp() + "\n parameters available:");
printParamInfo(s, out);
out.println(" able to style: " + s.getSupportedClasses());
addStylerForClass(s);
if (s.creates()) {
out.println(" creates supported Class");
}
}
}
printStylersPerClass(out);
}
public static void printStylersPerClass(PrintStream out) {
out.println("\nOverview of stylers available per iText Class (and its subclasses)\n");
for (Map.Entry>> e : stylersForClass.entrySet()) {
out.print("\nstylers for " + e.getKey().getSimpleName() + ": ");
for (Class bs : e.getValue()) {
out.print(bs.getSimpleName() + ", ");
}
}
out.println();
}
public static void printStylersPerClass(Document document, com.itextpdf.text.Font f) throws DocumentException {
document.add(Chunk.NEWLINE);
document.add(new Phrase("Overview of stylers available per iText Class (and its subclasses)", f));
document.add(Chunk.NEWLINE);
for (Map.Entry>> e : stylersForClass.entrySet()) {
document.add(Chunk.NEWLINE);
document.add(new Chunk("stylers for " + e.getKey().getSimpleName() + ": ", f));
for (Class bs : e.getValue()) {
document.add(new Chunk(bs.getSimpleName(), f).setLocalGoto(bs.getSimpleName()).setUnderline(0.3f, -1f));
document.add(new Chunk(", ", f));
}
}
}
public static void printHelp(PrintStream out) throws IOException, FileNotFoundException, ClassNotFoundException, InstantiationException, IllegalAccessException, NoSuchMethodException, InvocationTargetException {
printHelpHeader(out);
printStylerHelp(out);
printHelpFooter(out);
}
public static void printParamInfo(Parameterizable p, PrintStream out) {
for (Parameter e : p.getParameters().values()) {
out.println(" " + e);
}
}
public static String getClassInfo(String key, Class c) {
if (c != null) {
return (c.isArray()) ? "array of " + c.getComponentType().getName() : c.getName();
} else {
log.warning("class information for key: " + key + " is missing");
return "unknown";
}
}
public static String getParamInfo(Parameterizable p) {
StringBuilder sb = new StringBuilder(p.getParameters().size() * 20).append("\n");
for (Parameter e : p.getParameters().values()) {
sb.append(e.toString()).append("\n");
}
return sb.toString();
}
}