org.kepler.loader.util

Class UpdateActorTreeFiles

java.lang.Object

org.kepler.loader.util.UpdateActorTreeFiles

public class UpdateActorTreeFiles
extends java.lang.Object

A class to update the KAR XMLs for actors, directors, etc.

Author:

Daniel Crawl

Constructor Summary

Constructors

Constructor and Description
UpdateActorTreeFiles()

Method Summary

Modifier and Type	Method and Description
static void	buildKARXML(java.lang.String name, java.lang.String outputDir, java.lang.String outputName, boolean printWhenNameIsDifferent, boolean printWhenChangePropName, boolean duplicateExistingActor, boolean requireSemanticTypes) Create XML files for actor KARs.
static void	buildXMLs(java.lang.String[] args) Create XML files for a list of source files.
static org.kepler.build.modules.Module	findModuleSrcDirForNameObj(NamedObj namedObj) Find the module whose source directory contains a NamedObj.
static void	main(java.lang.String[] args) Update the KAR XMLs for modules.
static void	updateDocs(java.lang.String name, java.lang.String outputFileName, boolean printWhenChangePropName, java.lang.String lsidStr, boolean onlyCreateForMissing, boolean allowMultiClasses) Create XML files for actor KARs.
static void	updateKarXMLDocsForFile(java.lang.String[] args)
static void	updateKarXMLDocsForModule(java.lang.String moduleName) Update the KAR XML documentation for a module.

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateActorTreeFiles

public UpdateActorTreeFiles()

Method Detail

main

public static void main(java.lang.String[] args)

Update the KAR XMLs for modules.

Parameters:

args - a list of module names

updateKarXMLDocsForFile

public static void updateKarXMLDocsForFile(java.lang.String[] args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

updateKarXMLDocsForModule

public static void updateKarXMLDocsForModule(java.lang.String moduleName)
                                      throws java.lang.Exception

Update the KAR XML documentation for a module.

Throws:

java.lang.Exception

updateDocs

public static void updateDocs(java.lang.String name,
                              java.lang.String outputFileName,
                              boolean printWhenChangePropName,
                              java.lang.String lsidStr,
                              boolean onlyCreateForMissing,
                              boolean allowMultiClasses)
                       throws java.lang.Exception

Create XML files for actor KARs.

Parameters:

names - a java source file names or class name.

outputFileName - the name of the output file.

printWhenChangePropName - if true, print when the class field names in the docs are different from the name returned by NamedObj.getName().

lsidStr - the lsid

onlyCreateForMissing - if true, documentation is only created if not present.

allowMultiClasses - if true, create documentation even if multiple actors use the same class, e.g., customized versions of the R actor.

Throws:

java.lang.Exception

buildXMLs

public static void buildXMLs(java.lang.String[] args)

Create XML files for a list of source files.

buildKARXML

public static void buildKARXML(java.lang.String name,
                               java.lang.String outputDir,
                               java.lang.String outputName,
                               boolean printWhenNameIsDifferent,
                               boolean printWhenChangePropName,
                               boolean duplicateExistingActor,
                               boolean requireSemanticTypes)

Create XML files for actor KARs.

Parameters:

names - a java source file names or class name.

outputDir - the output directory to write the file to. if null, then try to guess module containing the source or class name and write to module/resources/kar. if cannot guess module, write to user.dir.

outputName - the name of the output file. if null, then use the short class name.

printWhenNameIsDifferent - if true, print when the class name and name in the cache are different.

printWhenChangePropName - if true, print when the class field names in the docs are different from the name returned by NamedObj.getName().

duplicateExistingActor - if true, create XML for actor already in cache. otherwise, do nothing.

requireSemanticTypes - if true, do not create XML for actors unless semantic types are known or can be guessed.

findModuleSrcDirForNameObj

public static org.kepler.build.modules.Module findModuleSrcDirForNameObj(NamedObj namedObj)
                                                                  throws java.lang.ClassNotFoundException

Find the module whose source directory contains a NamedObj. Returns null if not found.

Throws:

java.lang.ClassNotFoundException