com.bowstreet.builders.webapp.api
Class ServiceDocumentation

java.lang.Object
  com.bowstreet.builders.BaseBuilderAPI
      com.bowstreet.builders.webapp.api.ServiceDocumentation

public class ServiceDocumentation
extends com.bowstreet.builders.BaseBuilderAPI

Generate a report on the services implemented by or used by a given model or models.
Note: this is a builder API wrapper class, intended to be called by the regen logic of a builder. It can be used to programmatically add a call to the ServiceDocumentation builder to a model.

Nested Class Summary

static interface

ServiceDocumentation.BuilderStaticValues Constant values imported from the builder definition file.

Constructor Summary

ServiceDocumentation(BuilderCall parent, GenContext gc)

Method Summary

boolean	getCreateMain() Check if a 'main' method should be created.
java.lang.String	getModelName() Base model used to generate webapp entities
java.lang.String	getModelPageURL() Choose a file which will be used as the base HTML for the page showing model-specific information.
java.lang.String	getModelSelection() Choose how to select models for inclusion in the report Legal values: AllServiceModels (All service models), ServiceModelsMatchingPattern (Service models matching pattern), ThisModel (This model), SpecificModel (Specific model)
java.lang.String	getName() Specify name of this builder call
java.lang.String	getOperationPageURL() Choose a file which will be used as the base HTML for the page showing operation-specific information.
java.lang.String	getOuterPageURL() Choose a file which will be used as the base HTML for the outer page.
java.lang.String	getReportType() Generate documentation on services implemented or used by the selected model(s) Legal values: Implemented (Services implemented), Used (Services used)
java.lang.String	getServiceModelName() Name of model for which to generate report
java.lang.String	getServiceModelPattern() Pattern (regular expression) to select models which will appear in report
java.lang.String	getServicePageURL() Choose a file which will be used as the base HTML for the page showing service-specific information.
boolean	getShowSchemaElements() If selected, parmeter display will include elements of the schema.
void	initializeBuilderInputs()
void	setCreateMain(boolean value) Check if a 'main' method should be created.
void	setModelName(java.lang.String value) Base model used to generate webapp entities
void	setModelPageURL(java.lang.String value) Choose a file which will be used as the base HTML for the page showing model-specific information.
void	setModelSelection(java.lang.String value) Choose how to select models for inclusion in the report Legal values: AllServiceModels (All service models), ServiceModelsMatchingPattern (Service models matching pattern), ThisModel (This model), SpecificModel (Specific model)
void	setName(java.lang.String value) Specify name of this builder call
void	setOperationPageURL(java.lang.String value) Choose a file which will be used as the base HTML for the page showing operation-specific information.
void	setOuterPageURL(java.lang.String value) Choose a file which will be used as the base HTML for the outer page.
void	setReportType(java.lang.String value) Generate documentation on services implemented or used by the selected model(s) Legal values: Implemented (Services implemented), Used (Services used)
void	setServiceModelName(java.lang.String value) Name of model for which to generate report
void	setServiceModelPattern(java.lang.String value) Pattern (regular expression) to select models which will appear in report
void	setServicePageURL(java.lang.String value) Choose a file which will be used as the base HTML for the page showing service-specific information.
void	setShowSchemaElements(boolean value) If selected, parmeter display will include elements of the schema.

Methods inherited from class com.bowstreet.builders.BaseBuilderAPI

getBuilderCall, getBuilderInputs, invokeBuilder, invokeBuilderBC, setBuilderInputs

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceDocumentation

public ServiceDocumentation(BuilderCall parent,
                            GenContext gc)

Method Detail

getCreateMain

public boolean getCreateMain()

Check if a 'main' method should be created.

getModelName

public java.lang.String getModelName()

Base model used to generate webapp entities

getModelPageURL

public java.lang.String getModelPageURL()

Choose a file which will be used as the base HTML for the page showing model-specific information.

getModelSelection

public java.lang.String getModelSelection()

Choose how to select models for inclusion in the report
Legal values: AllServiceModels (All service models), ServiceModelsMatchingPattern (Service models matching pattern), ThisModel (This model), SpecificModel (Specific model)

getName

public java.lang.String getName()

Specify name of this builder call

getOperationPageURL

public java.lang.String getOperationPageURL()

Choose a file which will be used as the base HTML for the page showing operation-specific information.

getOuterPageURL

public java.lang.String getOuterPageURL()

Choose a file which will be used as the base HTML for the outer page.

getReportType

public java.lang.String getReportType()

Generate documentation on services implemented or used by the selected model(s)
Legal values: Implemented (Services implemented), Used (Services used)

getServiceModelName

public java.lang.String getServiceModelName()

Name of model for which to generate report

getServiceModelPattern

public java.lang.String getServiceModelPattern()

Pattern (regular expression) to select models which will appear in report

getServicePageURL

public java.lang.String getServicePageURL()

Choose a file which will be used as the base HTML for the page showing service-specific information.

getShowSchemaElements

public boolean getShowSchemaElements()

If selected, parmeter display will include elements of the schema.

initializeBuilderInputs

public void initializeBuilderInputs()

Overrides:

initializeBuilderInputs in class com.bowstreet.builders.BaseBuilderAPI

setCreateMain

public void setCreateMain(boolean value)

Check if a 'main' method should be created.

setModelName

public void setModelName(java.lang.String value)

Base model used to generate webapp entities

setModelPageURL

public void setModelPageURL(java.lang.String value)

Choose a file which will be used as the base HTML for the page showing model-specific information.

setModelSelection

public void setModelSelection(java.lang.String value)

Choose how to select models for inclusion in the report
Legal values: AllServiceModels (All service models), ServiceModelsMatchingPattern (Service models matching pattern), ThisModel (This model), SpecificModel (Specific model)

setName

public void setName(java.lang.String value)

Specify name of this builder call

setOperationPageURL

public void setOperationPageURL(java.lang.String value)

Choose a file which will be used as the base HTML for the page showing operation-specific information.

setOuterPageURL

public void setOuterPageURL(java.lang.String value)

Choose a file which will be used as the base HTML for the outer page.

setReportType

public void setReportType(java.lang.String value)

Generate documentation on services implemented or used by the selected model(s)
Legal values: Implemented (Services implemented), Used (Services used)

setServiceModelName

public void setServiceModelName(java.lang.String value)

Name of model for which to generate report

setServiceModelPattern

public void setServiceModelPattern(java.lang.String value)

Pattern (regular expression) to select models which will appear in report

setServicePageURL

public void setServicePageURL(java.lang.String value)

Choose a file which will be used as the base HTML for the page showing service-specific information.

setShowSchemaElements

public void setShowSchemaElements(boolean value)

If selected, parmeter display will include elements of the schema.