com.bowstreet.builders.webapp.api
Class Schema

java.lang.Object
  extended by com.bowstreet.builders.BaseBuilderAPI
      extended by com.bowstreet.builders.webapp.api.Schema

public class Schema
extends com.bowstreet.builders.BaseBuilderAPI

Imports a schema for use in your model. The schema can be used with the Variable Builder to provide type checking.
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 Schema builder to a model.


Nested Class Summary
static interface Schema.BuilderStaticValues
          Constant values imported from the builder definition file.
 
Constructor Summary
Schema(BuilderCall parent, GenContext gc)
           
 
Method Summary
 java.lang.String getDesignTimeImportCheckBox()
          Specify when you want to import the selected schema
Legal values: true (Import only at designtime (now)), false (Import on every model generation)
 java.lang.String getName()
          Specify name of this builder call (required and must contain only alphanumeric characters and underscores)
 boolean getRenameExisting()
          Allow overwriting by renaming existing object with this name
 java.lang.String getSchemaSourceType()
          Where to retrieve schema source from - existing file/url, or specified directly here as a builder input.
 java.lang.String getSchemaSourceValue()
          Specify variable value
 java.lang.String getURI()
          Schema can come from a variable, URI or file
 java.lang.String getURIOnly()
          URL (http://) to schema, or file location relative to J2EERoot, eg /schemas/books.xsd
 void initializeBuilderInputs()
           
 void setDesignTimeImportCheckBox(java.lang.String value)
          Specify when you want to import the selected schema
Legal values: true (Import only at designtime (now)), false (Import on every model generation)
 void setName(java.lang.String value)
          Specify name of this builder call (required and must contain only alphanumeric characters and underscores)
 void setRenameExisting(boolean value)
          Allow overwriting by renaming existing object with this name
 void setSchemaSourceType(java.lang.String value)
          Where to retrieve schema source from - existing file/url, or specified directly here as a builder input.
 void setSchemaSourceValue(java.lang.String value)
          Specify variable value
 void setURI(java.lang.String value)
          Schema can come from a variable, URI or file
 void setURIOnly(java.lang.String value)
          URL (http://) to schema, or file location relative to J2EERoot, eg /schemas/books.xsd
 
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

Schema

public Schema(BuilderCall parent,
              GenContext gc)
Method Detail

getDesignTimeImportCheckBox

public java.lang.String getDesignTimeImportCheckBox()
Specify when you want to import the selected schema
Legal values: true (Import only at designtime (now)), false (Import on every model generation)


getName

public java.lang.String getName()
Specify name of this builder call (required and must contain only alphanumeric characters and underscores)


getRenameExisting

public boolean getRenameExisting()
Allow overwriting by renaming existing object with this name


getSchemaSourceType

public java.lang.String getSchemaSourceType()
Where to retrieve schema source from - existing file/url, or specified directly here as a builder input.
Legal values: Existing (Existing URL/File), Explicit (Specify explicitly as builder input)


getSchemaSourceValue

public java.lang.String getSchemaSourceValue()
Specify variable value


getURI

public java.lang.String getURI()
Schema can come from a variable, URI or file


getURIOnly

public java.lang.String getURIOnly()
URL (http://) to schema, or file location relative to J2EERoot, eg /schemas/books.xsd


initializeBuilderInputs

public void initializeBuilderInputs()
Overrides:
initializeBuilderInputs in class com.bowstreet.builders.BaseBuilderAPI

setDesignTimeImportCheckBox

public void setDesignTimeImportCheckBox(java.lang.String value)
Specify when you want to import the selected schema
Legal values: true (Import only at designtime (now)), false (Import on every model generation)


setName

public void setName(java.lang.String value)
Specify name of this builder call (required and must contain only alphanumeric characters and underscores)


setRenameExisting

public void setRenameExisting(boolean value)
Allow overwriting by renaming existing object with this name


setSchemaSourceType

public void setSchemaSourceType(java.lang.String value)
Where to retrieve schema source from - existing file/url, or specified directly here as a builder input.
Legal values: Existing (Existing URL/File), Explicit (Specify explicitly as builder input)


setSchemaSourceValue

public void setSchemaSourceValue(java.lang.String value)
Specify variable value


setURI

public void setURI(java.lang.String value)
Schema can come from a variable, URI or file


setURIOnly

public void setURIOnly(java.lang.String value)
URL (http://) to schema, or file location relative to J2EERoot, eg /schemas/books.xsd



Copyright © 2009 IBM. All Rights Reserved.