DOAPamine

DOAPamine is set of Java 5 Annotations that can be used to insert DOAP data into Java classes. Also included is an Ant task to reflect on the annotations and produce DOAP in RDF/XML.

The very, very, very beta release can be downloaded here. The sourcecode is licensed under a BSD style license, and is included in the jar file. There is no documentation other than this page. If DOAPamine generates any interest, I'll put together a proper distribution.

If you find this useful, have questions or want to suggest improvements, email me at brian dot manley at gmail dot com.

DOAPamine HOWTO

Using the annotations is quite easy. This example shows a simple class, which uses all the DOAP annotations provided. The annotations are available an runtime so that we can reflect through them when needed.

import com.triplescape.doapamine; @Project( name="DOAPamine", homepage="http://www.triplescape.com/doapamine", old_homepage={}, category={ "http://freshmeat.net/browse/45/", "http://freshmeat.net/browse/198/" }, created="2005-10-15", shortdesc="Ant task and annotations to create DOAP from Java.", description="DOAPamine generates DOAP from custom class/package annotations.", mailinglist={}, license={ "http://www.opensource.org/licenses/bsd-license.php" }, download_page="http://www.triplescape.com/doapamine", download_mirror={}, wiki="", bug_database="", screenshots={}, programming_language="java", os={}, platform="java", vendor="", service_endpoint="", blog="http://blog.triplescape.com", audience="developers", language="en", release=@Version(name="unstable", created="2009-05-18", revision="0.4", os="any", platform="java", file_release="http://www.triplescape.com/doapamine/doapamine-0.4.jar"), _implements= { @Specification(about="http://usefulinc.com/ns/doap") }, developer={ @Person(name="Brian Manley", mbox="xxxx@gmail.com", seeAlso="http://blog.triplescape.com/bmanley.rdf") }, maintainer={}, documentor={}, translator={}, tester={}, helper={}, repository=@Repository(type=Repository.type.NONE, browse="", anon_root="", location="", module="") public class DOAPExample { public static void main(String[] args) { System.out.println("Hello, ya big DOAP!"); } }

Once you've added the DOAPamine annotations to some Java class, you can use the DOAPTask Ant task to reflect on the annotations and generate DOAP in RDF/XML format. Only two parameters are needed: class which should be the fully qualified name of the class that contains the annotations and output which is the name of the file to write to.

Note that the doapamine.jar file must be in your CLASSPATH in order for Ant to find it.

<?xml version="1.0"?> <project name="doaptest" default="all" basedir="."> <taskdef name="doap" classname="com.triplescape.doapamine.DOAPTask" classpath="../jars/doapamine.jar"/> <target name="all" description="Does everything."> <doap class="com.ontogon.doapamine.DOAExample" output="doap.rdf"/> </target> </project>

And this is the output. Notice that annotation values with no value ("" or {}) are not emitted.

<?xml version="1.0"?> <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#" xmlns:foaf="http://xmlns.com/foaf/0.1/" xmlns="http://usefulinc.com/ns/doap#"> <Project> <name>DOAPamine</name> <homepage rdf:resource="http://www.triplescape.com/doapamine"/> <shortdesc>Ant task and annotations to create DOAP from Java.</shortdesc> <description>DOAPamine generates DOAP from custom class/package annotations.</description> <repository> <SVNRepository> <anon-root rdf:resource="b"/> <browse rdf:resource="a"/> <module>d</module> <location rdf:resource="c"/> </SVNRepository> </repository> <Release> <version> <name>unstable</name> <created>2009-05-18</created> <revision>0.4</revision> <file-release rdf:resource="http://www.triplescape.com/doapamine/doapamine-0.4.jar"/> </version> </Release> <implements> <Specification rdf:about="http://usefulinc.com/ns/doap"/> </implements> <download-page rdf:resource="http://www.triplescape.com/doapamine"/> <blog rdf:resource="http://blog.triplescape.com"/> <license rdf:resource="http://www.opensource.org/licenses/bsd-license.php"/> <category rdf:resource="http://freshmeat.net/browse/45/"/> <category rdf:resource="http://freshmeat.net/browse/198/"/> <programming-language>java</programming-language> <language>en</language> <platform>java</platform> <audience>developers</audience> <developer> <foaf:Person> <foaf:name>Brian Manley</foaf:name> <foaf:mbox rdf:resource="mailto:brian.manley@gmail.com"/> <rdfs:seeAlso rdf:resource="http://blog.triplescape.com/bmanley.rdf"/> </foaf:Person> </developer> </Project> <rdf:Description rdf:about=""> <foaf:maker> <foaf:Agent> <foaf:name>com.triplescape.doapamine.DOAPTask</foaf:name> <foaf:homepage rdf:resource="http:/www.triplescape.com/doapamine"/> </foaf:Agent> </foaf:maker> </rdf:Description> </rdf:RDF>