org.erowid.masterdoc
Class MasterRepository

java.lang.Object
  org.erowid.masterdoc.Repository
      org.erowid.masterdoc.MasterRepository

public class MasterRepository

extends Repository

The API to generate.

Version:

: $Header: /cvsroot/sperowider/SPEROWIDER_MODULE/javasource/org/erowid/masterdoc/MasterRepository.java,v 1.4 2005/01/15 23:26:17 gurustu Exp $

Author:

: $Author: gurustu $

Field Summary

static String	APPLET Applet search engine, for setSearchEngineType(String).
static String	SERVLET Servlet search engine, for setSearchEngineType(String).

Constructor Summary

MasterRepository(String name, String shortDescription, String longDescription)

Method Summary

void	addExternalJar(File path) Adds an external jar to link to
void	addRepository(Repository repository) Adds a Repository.
String	getClassPath() Returns the classpath that includes all the included jars.
String	getExternalApiRoot()
String	getExternalDocRoot() Returns the external Doc Root.
Collection	getExternalRepositories()
ExternalRepository	getExternalRepository(String name) Returns a named external repository
String	getExternalSearchRoot() Returns the externalSearchRoot.
File	getInternalApiRoot()
File	getInternalDocRoot() Returns the internal Doc Root.
File	getInternalMainRoot()
Collection	getInternalRepositories()
InternalRepository	getInternalRepository(String name) Returns a named internal repository
File	getInternalSearchRoot() Returns the internalSearchRoot.
String	getSearchEngineType()
boolean	isGenerateApi() Returns the generateAPI.
boolean	isGenerateDocs() Returns true if the docbase should be generated
boolean	isGenerateSearch() Returns true if the searchbase should be generated
boolean	isIncludeApiInSearch()
boolean	isIncludeDocsInSearch()
void	setExternalApiRoot(String externalAPIRoot) Sets the external API root
void	setExternalDocRoot(String externalDocRoot) Sets the external doc root
void	setExternalSearchRoot(String externalSearchRoot) Sets the external search root
void	setGenerateApi(boolean generateAPI) Sets the generateAPI flag.
void	setGenerateDocs(boolean generateDocs) Sets if the docbase should be generated
void	setGenerateSearch(boolean generateSearch) Set true to generate the searchbase
void	setIncludeApiInSearch(boolean includeApiInSearch)
void	setIncludeDocsInSearch(boolean includeDocsInSearch)
void	setInternalApiRoot(File internalAPIRoot) Sets the internal API root
void	setInternalDocRoot(File internalDocRoot) Sets the internal doc root
void	setInternalMainRoot(File internalMainRoot)
void	setInternalSearchRoot(File internalSearchRoot) Sets the internal search root
void	setSearchEngineType(String searchEngineType)

Methods inherited from class org.erowid.masterdoc.Repository

getGeneralUrl, getLongDescription, getName, getPathFromFileList, getShortDescription, hasGeneralUrl, setGeneralUrl, setLongDescription, setName, setShortDescription

Methods inherited from class java.lang.Object

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

Field Detail

APPLET

public static final String APPLET

Applet search engine, for setSearchEngineType(String). Value : "applet"

See Also:

Constant Field Values

SERVLET

public static final String SERVLET

Servlet search engine, for setSearchEngineType(String). Value : "servlet"

See Also:

Constant Field Values

Constructor Detail

MasterRepository

public MasterRepository(String name,
                        String shortDescription,
                        String longDescription)

Parameters:

name -

shortDescription -

longDescription -

Method Detail

getInternalMainRoot

public File getInternalMainRoot()

Returns:

Returns the internalMainRoot.

setInternalMainRoot

public void setInternalMainRoot(File internalMainRoot)

Parameters:

internalMainRoot - The internalMainRoot to set.

isGenerateSearch

public boolean isGenerateSearch()

Returns true if the searchbase should be generated

setGenerateSearch

public void setGenerateSearch(boolean generateSearch)

Set true to generate the searchbase

getExternalSearchRoot

public String getExternalSearchRoot()

Returns the externalSearchRoot.

getInternalSearchRoot

public File getInternalSearchRoot()

Returns the internalSearchRoot.

setExternalSearchRoot

public void setExternalSearchRoot(String externalSearchRoot)

Sets the external search root

setInternalSearchRoot

public void setInternalSearchRoot(File internalSearchRoot)

Sets the internal search root

getSearchEngineType

public String getSearchEngineType()

Returns:

Returns the searchEngineType.

setSearchEngineType

public void setSearchEngineType(String searchEngineType)

Parameters:

searchEngineType - The searchEngineType to set.

isIncludeApiInSearch

public boolean isIncludeApiInSearch()

Returns:

Returns the includeApiInSearch.

setIncludeApiInSearch

public void setIncludeApiInSearch(boolean includeApiInSearch)

Parameters:

includeApiInSearch - The includeApiInSearch to set.

isIncludeDocsInSearch

public boolean isIncludeDocsInSearch()

Returns:

Returns the includeDocsInSearch.

setIncludeDocsInSearch

public void setIncludeDocsInSearch(boolean includeDocsInSearch)

Parameters:

includeDocsInSearch - The includeDocsInSearch to set.

getExternalApiRoot

public String getExternalApiRoot()

Returns:

Returns the external API Root.

getInternalApiRoot

public File getInternalApiRoot()

Returns:

Returns the internal API Root.

setExternalApiRoot

public void setExternalApiRoot(String externalAPIRoot)

Sets the external API root

setInternalApiRoot

public void setInternalApiRoot(File internalAPIRoot)

Sets the internal API root

isGenerateApi

public boolean isGenerateApi()

Returns the generateAPI.

setGenerateApi

public void setGenerateApi(boolean generateAPI)

Sets the generateAPI flag. If this is false, new APIs won't be generated, though docs will be downloaded and search indexes created.

getExternalDocRoot

public String getExternalDocRoot()

Returns the external Doc Root.

getInternalDocRoot

public File getInternalDocRoot()

Returns the internal Doc Root.

setExternalDocRoot

public void setExternalDocRoot(String externalDocRoot)

Sets the external doc root

setInternalDocRoot

public void setInternalDocRoot(File internalDocRoot)

Sets the internal doc root

isGenerateDocs

public boolean isGenerateDocs()

Returns true if the docbase should be generated

setGenerateDocs

public void setGenerateDocs(boolean generateDocs)

Sets if the docbase should be generated

getExternalRepositories

public Collection getExternalRepositories()

Returns:

Returns the external APIs

getInternalRepositories

public Collection getInternalRepositories()

Returns:

Returns the internal APIs.

getInternalRepository

public InternalRepository getInternalRepository(String name)

Returns a named internal repository

getExternalRepository

public ExternalRepository getExternalRepository(String name)

Returns a named external repository

addRepository

public void addRepository(Repository repository)

Adds a Repository.

addExternalJar

public void addExternalJar(File path)

Adds an external jar to link to

getClassPath

public String getClassPath()

Returns the classpath that includes all the included jars.