001: /*
002: * Hammurapi
003: * Automated Java code review system.
004: * Copyright (C) 2004 Hammurapi Group
005: *
006: * This program is free software; you can redistribute it and/or modify
007: * it under the terms of the GNU General Public License as published by
008: * the Free Software Foundation; either version 2 of the License, or
009: * (at your option) any later version.
010: *
011: * This program is distributed in the hope that it will be useful,
012: * but WITHOUT ANY WARRANTY; without even the implied warranty of
013: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
014: * GNU General Public License for more details.
015: *
016: * You should have received a copy of the GNU General Public License
017: * along with this program; if not, write to the Free Software
018: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
019: *
020: * URL: http://www.hammurapi.org
021: * e-Mail: support@hammurapi.biz
022: */
023:
024: package org.hammurapi.inspectors;
025:
026: import java.io.FileWriter;
027: import java.io.IOException;
028: import java.io.Writer;
029: import java.util.Properties;
030:
031: import org.hammurapi.InspectorBase;
032: import org.hammurapi.HammurapiException;
033: import org.hammurapi.results.AnnotationContext;
034: import org.hammurapi.results.InlineAnnotation;
035: import org.hammurapi.results.LinkedAnnotation;
036:
037: import com.pavelvlasov.config.ConfigurationException;
038: import com.pavelvlasov.jsel.CompilationUnit;
039:
040: /**
041: * This class demostrates how to:
042: * Generate annotations with multiple files
043: * Use renderers and embedded styles
044: * Read inspector parameters
045: * Read annotation config parameters
046: * getConfigInfo implementation
047: *
048: * @author Pavel Vlasov
049: * @version $Revision: 1.2 $
050: */
051: public class SimpleAnnotationSample extends InspectorBase {
052:
053: public void visit(final CompilationUnit compilationUnit) {
054: context.annotate(new LinkedAnnotation() {
055: private String path;
056: private String cuPath = compilationUnit.getRelativeName();
057:
058: public String getName() {
059: return getContext().getDescriptor().getName();
060: }
061:
062: public String getPath() {
063: return path;
064: }
065:
066: public void render(final AnnotationContext context)
067: throws HammurapiException {
068: final AnnotationContext.FileEntry linkEntry = context
069: .getNextFile(".txt");
070:
071: try {
072: Writer out = new FileWriter(linkEntry.getFile());
073: try {
074: out.write("Hello, world!!!");
075: } finally {
076: out.close();
077: }
078: } catch (IOException e) {
079: throw new HammurapiException("Cannot save "
080: + linkEntry.getFile().getAbsolutePath(), e);
081: }
082:
083: AnnotationContext.FileEntry fileEntry = context
084: .getNextFile(context.getExtension());
085: path = fileEntry.getPath(); // This file is the entry point to the annotation.
086: try {
087: Writer out = new FileWriter(fileEntry.getFile());
088: try {
089: out
090: .write("<HTML><BODY><H1>My simple annotation</H1>"
091: + "PI: "
092: + pi
093: + "<P><a href=\""
094: + linkEntry.getPath()
095: + "\">Greeting</a>"
096: + "</BODY></HTML>");
097: } finally {
098: out.close();
099: }
100: } catch (IOException e) {
101: throw new HammurapiException("Cannot save "
102: + linkEntry.getFile().getAbsolutePath(), e);
103: }
104: }
105:
106: public Properties getProperties() {
107: return null;
108: }
109: });
110:
111: context.annotate(new InlineAnnotation() {
112:
113: public String getContent() {
114: return "<DIV style=\"border:solid; background-color:yellow\">Simple annotation sample</DIV>";
115: }
116:
117: public String getName() {
118: return getContext().getDescriptor().getName();
119: }
120:
121: public void render(AnnotationContext context)
122: throws HammurapiException {
123: // This annotation doesn't create any additional files, so this method is empty
124:
125: }
126:
127: public Properties getProperties() {
128: return null;
129: }
130:
131: });
132: }
133:
134: private Double pi;
135:
136: public void setParameter(String name, Object parameter)
137: throws ConfigurationException {
138: if ("pi".equals(name)) {
139: pi = (Double) parameter;
140: } else {
141: throw new ConfigurationException("Parameter " + name
142: + " is not supported");
143: }
144: }
145:
146: public String getConfigInfo() {
147: return "PI=" + pi;
148: }
149:
150: }
|