ariba.ui.aribaweb.core
Class AWComponentDefinition

java.lang.Object
  ariba.ui.aribaweb.util.AWBaseObject
      ariba.ui.aribaweb.core.AWComponentDefinition

All Implemented Interfaces:

AWObject

public class AWComponentDefinition
extends AWBaseObject

Nested Class Summary

class	AWComponentDefinition.ComponentReferenceLocation
class	AWComponentDefinition.EmpiricalApiData
static interface	AWComponentDefinition.ScriptClassProvider

Field Summary

Fields inherited from class ariba.ui.aribaweb.util.AWBaseObject

AribaHashtableClass, AribaVectorClass, ClassClass, EmptyHashtable, EmptyMap, EmptyVector, False, IntegerClass, JavaHashtableClass, JavaMapClass, JavaVectorClass, LogHandling, NullObject, ObjectClass, StringClass, True, UndefinedObject, UndefinedString, UninitializedRealNumber

Constructor Summary

AWComponentDefinition()

Method Summary

void	addBindingReference(AWComponent component, String bindingName)
void	addEmpiricalBinding(String bindingName, AWComponent parent) AWApi not defined for element so collect all bindings
void	addInvalidComponentApiAlternate(AWValidationContext validationContext, String bindingName, String alternateBindingName) Called when a binding Api has an alternate specified and the alternate does not have an Api defined.
void	addInvalidComponentApiBindingDefinition(AWValidationContext validationContext, String key, int type)
void	addInvalidValueForBinding(AWValidationContext validationContext, AWComponent component, String bindingName, String errorMessage)
void	addMismatchedComponentApiAlternates(AWValidationContext validationContext, String bindingName, String alternateBindingName) Called when a binding Api has an alternate specified and the alternate binding Api does not have the same alternate list.
void	addMissingRequiredBinding(AWValidationContext validationContext, AWComponent component, String bindingName)
void	addPassThroughBinding(AWValidationContext validationContext, AWComponent component, String bindingName)
void	addReferencedBy(AWComponent component) Track the components that reference this component.
void	addUnknownTag(AWValidationContext validationContext, String tagName, String templateName, int currentLine) Strict tag naming is enabled and a tag was found whose name starts with an uppercase character and no corresponding component was found.
void	addUnsupportedBinding(AWValidationContext validationContext, AWComponent component, String bindingName)
List	bindingErrorList()
Map	bindingFields()
void	checkInSharedComponentInstance(AWComponent componentInstance)
AWApi	componentApi()
int	componentApiErrorCount()
Class	componentClass()
int	componentDefinitionId()
String	componentName()
String	componentNamePath()
String	componentPackageName()
static String	computeClassNameFromTemplate(String templateName) Given a template name, compute the associated class name.
static String	computeTemplateName(Class componentClass)
static String	computeTemplateName(Class componentClass, String extension)
static String	computeTemplateName(String className, String extension)
AWComponent	createComponent(AWComponentReference componentReference, AWComponent parent, AWRequestContext requestContext)
AWTemplate	defaultTemplate()
Map	empiricalApiTable()
boolean	hasValidationErrors()
void	init(String componentName, Class componentClass)
List	invalidComponentBindingApiAlternates()
boolean	isClassless() Check whether this component is classless.
boolean	isPageLevel()
boolean	isStateless()
void	logReloadString(String s)
List	mismatchedComponentBindingApiAlternates()
List	missingSupportedBindingDefinitions()
String	printComponentApiErrors()
List	referencedBy()
List	referencedByLocations()
static void	registerScriptProvider(String tagName, AWComponentDefinition.ScriptClassProvider provider)
void	resetValidationData()
String	resourceClassName(AWComponent componentInstance) Get the name of the class where we get our resources from.
void	setIsPageLevel(boolean flag)
void	setTemplateName(String templateName)
AWComponent	sharedComponentInstance()
AWComponentReference	sharedComponentReference()
String[]	supportedBindingNames()
String	templateName()
List	templateParsingErrors() Template Parsing errors
String	toString()
List	unsupportedBindingDefinitions()
boolean	usesOwnTemplate(AWComponent component) Weird method to check if the class has overriden templateName() to return a different template than .awl.
int	validationErrorCount()

Methods inherited from class ariba.ui.aribaweb.util.AWBaseObject

debugString, ensureFieldValuesClear, getFieldValue, init, isKindOfClass, localizedJavaString, logString, logWarning, setFieldValue

Methods inherited from class java.lang.Object

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

Constructor Detail

AWComponentDefinition

public AWComponentDefinition()

Method Detail

registerScriptProvider

public static void registerScriptProvider(String tagName,
                                          AWComponentDefinition.ScriptClassProvider provider)

computeTemplateName

public static String computeTemplateName(String className,
                                         String extension)

computeTemplateName

public static String computeTemplateName(Class componentClass,
                                         String extension)

computeTemplateName

public static String computeTemplateName(Class componentClass)

computeClassNameFromTemplate

public static String computeClassNameFromTemplate(String templateName)

Given a template name, compute the associated class name.

Parameters:

templateName - - a template name, calculated according to computeTemplateName

Returns:

a fully qualified class name

init

public void init(String componentName,
                 Class componentClass)

setTemplateName

public void setTemplateName(String templateName)

isStateless

public boolean isStateless()

componentName

public String componentName()

componentNamePath

public String componentNamePath()

isClassless

public boolean isClassless()

Check whether this component is classless. A classless component only has an awl file - no java class.

Returns:

true if this component is classless

componentClass

public Class componentClass()

templateName

public String templateName()

componentPackageName

public String componentPackageName()

resourceClassName

public String resourceClassName(AWComponent componentInstance)

Get the name of the class where we get our resources from. This is the class in which we resolve AWLocal references.

Parameters:

componentInstance - - the component whose resource class we're fetching

Returns:

the full class name of the resource class

supportedBindingNames

public String[] supportedBindingNames()

sharedComponentReference

public AWComponentReference sharedComponentReference()

componentDefinitionId

public int componentDefinitionId()

componentApi

public AWApi componentApi()

createComponent

public AWComponent createComponent(AWComponentReference componentReference,
                                   AWComponent parent,
                                   AWRequestContext requestContext)

sharedComponentInstance

public AWComponent sharedComponentInstance()

checkInSharedComponentInstance

public void checkInSharedComponentInstance(AWComponent componentInstance)

toString

public String toString()

Overrides:

toString in class Object

defaultTemplate

public AWTemplate defaultTemplate()

bindingFields

public Map bindingFields()

logReloadString

public void logReloadString(String s)

resetValidationData

public void resetValidationData()

bindingErrorList

public List bindingErrorList()

hasValidationErrors

public boolean hasValidationErrors()

empiricalApiTable

public Map empiricalApiTable()

validationErrorCount

public int validationErrorCount()

componentApiErrorCount

public int componentApiErrorCount()

addReferencedBy

public void addReferencedBy(AWComponent component)

Track the components that reference this component.

Parameters:

component -

referencedBy

public List referencedBy()

referencedByLocations

public List referencedByLocations()

setIsPageLevel

public void setIsPageLevel(boolean flag)

isPageLevel

public boolean isPageLevel()

unsupportedBindingDefinitions

public List unsupportedBindingDefinitions()

missingSupportedBindingDefinitions

public List missingSupportedBindingDefinitions()

addInvalidComponentApiBindingDefinition

public void addInvalidComponentApiBindingDefinition(AWValidationContext validationContext,
                                                    String key,
                                                    int type)

invalidComponentBindingApiAlternates

public List invalidComponentBindingApiAlternates()

mismatchedComponentBindingApiAlternates

public List mismatchedComponentBindingApiAlternates()

addInvalidComponentApiAlternate

public void addInvalidComponentApiAlternate(AWValidationContext validationContext,
                                            String bindingName,
                                            String alternateBindingName)

Called when a binding Api has an alternate specified and the alternate does not have an Api defined.

Parameters:

validationContext -

bindingName - binding on which an alternate is defined

alternateBindingName - alternate binding name

addMismatchedComponentApiAlternates

public void addMismatchedComponentApiAlternates(AWValidationContext validationContext,
                                                String bindingName,
                                                String alternateBindingName)

Called when a binding Api has an alternate specified and the alternate binding Api does not have the same alternate list.

Parameters:

validationContext -

bindingName - binding on which an alternate is defined

alternateBindingName - alternate binding name

templateParsingErrors

public List templateParsingErrors()

Template Parsing errors

addUnknownTag

public void addUnknownTag(AWValidationContext validationContext,
                          String tagName,
                          String templateName,
                          int currentLine)

Strict tag naming is enabled and a tag was found whose name starts with an uppercase character and no corresponding component was found.

Parameters:

validationContext -

tagName -

templateName -

currentLine -

addUnsupportedBinding

public void addUnsupportedBinding(AWValidationContext validationContext,
                                  AWComponent component,
                                  String bindingName)

addInvalidValueForBinding

public void addInvalidValueForBinding(AWValidationContext validationContext,
                                      AWComponent component,
                                      String bindingName,
                                      String errorMessage)

addMissingRequiredBinding

public void addMissingRequiredBinding(AWValidationContext validationContext,
                                      AWComponent component,
                                      String bindingName)

addEmpiricalBinding

public void addEmpiricalBinding(String bindingName,
                                AWComponent parent)

AWApi not defined for element so collect all bindings

Parameters:

bindingName - bindind used

parent - component in which the binding is used

addPassThroughBinding

public void addPassThroughBinding(AWValidationContext validationContext,
                                  AWComponent component,
                                  String bindingName)

addBindingReference

public void addBindingReference(AWComponent component,
                                String bindingName)

printComponentApiErrors

public String printComponentApiErrors()

usesOwnTemplate

public boolean usesOwnTemplate(AWComponent component)

Weird method to check if the class has overriden templateName() to return a different template than .awl. (e.g. AWVTextField). In this case, we don't force full AWApi documentation.