org.kepler.gui

Class KeplerDocApplicationSpecializer

java.lang.Object

org.kepler.gui.KeplerDocApplicationSpecializer

All Implemented Interfaces:

DocApplicationSpecializer

public class KeplerDocApplicationSpecializer
extends java.lang.Object
implements DocApplicationSpecializer

Kepler specific specialization of the Ptolemy II Documentation system.

Since:

Ptolemy II 6.0

Author:

Christopher Brooks

Pt.AcceptedRating:

Red (cxh)

Pt.ProposedRating:

Red (cxh)

Constructor Summary

Constructors

Constructor and Description
KeplerDocApplicationSpecializer()

Method Summary

Modifier and Type	Method and Description
java.util.List	buildCommands(ExecuteCommands executeCommands) Set up the commands necessary to build the documentation.
java.net.URL	docClassNameToURL(java.lang.String remoteDocumentationURLBase, java.lang.String className, boolean lookForPtDoc, boolean lookForJavadoc, boolean lookForSource, boolean lookForActorIndex) Given a dot separated class name, return the URL of the PtDoc .xml file documentation or the Actor Index.
void	editDocumentation(java.awt.Frame owner, Attribute attribute, NamedObj target) create a gui to edit the documentation in the attribute
java.lang.String	getDocumentationAttributeClassName() returns the name of the documentation attribute
void	handleDocumentationAttributeDoesNotExist(java.awt.Frame owner, NamedObj target) handle the case where the component does not have a KeplerDocumentation attribute
void	handleDocumentationNotFound(java.lang.String classname, Effigy effigy) handle the case where the user tried to edit documentation and the attribute does not exist.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KeplerDocApplicationSpecializer

public KeplerDocApplicationSpecializer()

Method Detail

docClassNameToURL

public java.net.URL docClassNameToURL(java.lang.String remoteDocumentationURLBase,
                                      java.lang.String className,
                                      boolean lookForPtDoc,
                                      boolean lookForJavadoc,
                                      boolean lookForSource,
                                      boolean lookForActorIndex)

Given a dot separated class name, return the URL of the PtDoc .xml file documentation or the Actor Index. All other document types (Javadoc, source documentation) are currently not not searched for. Thus the either the lookForPtDoc or lookForActorIndex parameter must be true, otherwise this method will return null.

If the KEPLER_DOCS property is set, then its value is assumed to point to the Kepler documentation. If KEPLER_DOCS is not set, then the file ./doc/docsInfo.txt is read, and if that file contains the string of the format KeplerDocs: path to kepler-docs then the value of path to kepler-docs is used. For example, docsInfo.txt might contain KeplerDocs: c:\src\kepler-docs, which means that the documentation is to be found in c:\src\kepler-docs. docsInfo.txt is created by running cd $KEPLER; ant generateDoc. The documentation for className is assumed to be in $KEPLER_DOCS/dev/documentationFramework/generatedJavadocs/className.doc.xml.

Specified by:

docClassNameToURL in interface DocApplicationSpecializer

Parameters:

remoteDocumentationURLBase - If non-null, the URL of the documentation. Usually, this is set by reading the _remoteDocumentationBase parameter from the configuration in the caller.

className - The dot separated class name.

lookForPtDoc - True if we should look for ptdoc .xml files.

lookForJavadoc - Ignored

lookForSource - Ignored

lookForActorIndex - True if we should search for the actor index *Idx.htm file.

Returns:

The URL of the documentation, if any. If no documentation was found, return null.

buildCommands

public java.util.List buildCommands(ExecuteCommands executeCommands)

Set up the commands necessary to build the documentation. For Kepler, we run "ant generateDoc" in $KEPLER>

Specified by:

buildCommands in interface DocApplicationSpecializer

Parameters:

executeCommands - The command execution environment necessary to build the documentation.

Returns:

A List of Strings, where each String represents the a command to be executed.

getDocumentationAttributeClassName

public java.lang.String getDocumentationAttributeClassName()

returns the name of the documentation attribute

Specified by:

getDocumentationAttributeClassName in interface DocApplicationSpecializer

Returns:

the name of the class of the specialized documentation attribute

editDocumentation

public void editDocumentation(java.awt.Frame owner,
                              Attribute attribute,
                              NamedObj target)

create a gui to edit the documentation in the attribute

Specified by:

editDocumentation in interface DocApplicationSpecializer

Parameters:

owner - the editors gui parent

attribute - the documentation attribute to edit

target - the parent component to the attribute

handleDocumentationAttributeDoesNotExist

public void handleDocumentationAttributeDoesNotExist(java.awt.Frame owner,
                                                     NamedObj target)

handle the case where the component does not have a KeplerDocumentation attribute

Specified by:

handleDocumentationAttributeDoesNotExist in interface DocApplicationSpecializer

Parameters:

target - the component

owner - the editors gui parent

handleDocumentationNotFound

public void handleDocumentationNotFound(java.lang.String classname,
                                        Effigy effigy)

handle the case where the user tried to edit documentation and the attribute does not exist.

Specified by:

handleDocumentationNotFound in interface DocApplicationSpecializer

Parameters:

classname - the name of the class

effigy - the effigy of the entity that does not have a doc attribute