com.partnersoft.cog

Class AbstractCogType

java.lang.Object

com.partnersoft.cog.AbstractCogType

All Implemented Interfaces:

Coggable, CogType, Immutable

Direct Known Subclasses:

CogCollectionType, CogEnumeratedType, CogPrimitiveType, CogStructureType

public abstract class AbstractCogType
extends java.lang.Object
implements CogType

A generic implementation of CogType that takes care of a few minor details for you.

Subclasses must call the superclass versions when implementing the Coggable methods.

Copyright 2006-2009 Partner Software, Inc.

Author:

Paul Reavis

Constructor Summary

Constructors

Constructor and Description
AbstractCogType(Cog state)
AbstractCogType(java.lang.String name, java.lang.String javaClassName, java.lang.String controlName, Cog prototype)

Method Summary

Methods

Modifier and Type	Method and Description
Form	buildForm()
FormField	buildFormField() Builds a FormField based on the control script.
Cog	createNode() Creates a new node of this type.
java.lang.String	getControlName() Name of GUI or web control to use to edit this type.
protected Script	getControlScript()
java.lang.String	getControlScriptPath() Path to script that builds control to use to edit this type.
java.lang.String	getJavaClassName() Name of Java class associated with this type.
java.lang.String	getName() Name of the type, used for lookups in an CogSchema.
Cog	getPrototype() Returns the prototype
protected java.lang.Object	runControlScript()
protected void	setControlName(java.lang.String controlName) Sets the controlName
protected void	setControlScript(Script controlScript) Sets the controlScript
protected void	setControlScriptPath(java.lang.String controlScriptPath) Sets the controlScriptPath
protected void	setJavaClassName(java.lang.String javaClassName) Sets the javaClassName
protected void	setName(java.lang.String name) Sets the name
protected void	setPrototype(Cog prototype) Sets the prototype
Cog	toCog() Returns the complete internal state of this object in the form of a Cog.
java.lang.String	toString()
java.util.List<CogValidationException>	validate(Cog node) Validates the given node structure as best it can.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.partnersoft.cog.CogType

cleanStructureOf

Constructor Detail

AbstractCogType

public AbstractCogType(Cog state)

AbstractCogType

public AbstractCogType(java.lang.String name,
               java.lang.String javaClassName,
               java.lang.String controlName,
               Cog prototype)

Method Detail

toCog

public Cog toCog()

Description copied from interface: Coggable

Returns the complete internal state of this object in the form of a Cog.

Specified by:

toCog in interface Coggable

Returns:

Cog representing the internal state of this object

validate

public java.util.List<CogValidationException> validate(Cog node)

Description copied from interface: CogType

Validates the given node structure as best it can.

Specified by:

validate in interface CogType

Parameters:

node - node to validate

createNode

public Cog createNode()

Description copied from interface: CogType

Creates a new node of this type. Generally this is done by copying a prototype value but may involve some other mechanism.

Specified by:

createNode in interface CogType

getName

public java.lang.String getName()

Description copied from interface: CogType

Name of the type, used for lookups in an CogSchema.

Specified by:

getName in interface CogType

Returns:

the name of this type.

getJavaClassName

public java.lang.String getJavaClassName()

Description copied from interface: CogType

Name of Java class associated with this type. May be null. If present, you can generally instantiate the class given.

Specified by:

getJavaClassName in interface CogType

Returns:

class name associated with this type

See Also:

CogType.getJavaClassName()

getControlName

public java.lang.String getControlName()

Description copied from interface: CogType

Name of GUI or web control to use to edit this type.

Specified by:

getControlName in interface CogType

Returns:

name of gui or web control to use for editing

See Also:

CogType.getControlName()

getControlScriptPath

public java.lang.String getControlScriptPath()

Description copied from interface: CogType

Path to script that builds control to use to edit this type.

Specified by:

getControlScriptPath in interface CogType

See Also:

CogType.getControlScriptPath()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

buildFormField

public FormField buildFormField()

Description copied from interface: CogType

Builds a FormField based on the control script.

Specified by:

buildFormField in interface CogType

buildForm

public Form buildForm()

runControlScript

protected java.lang.Object runControlScript()

getControlScript

protected Script getControlScript()

getPrototype

public Cog getPrototype()

Returns the prototype

Returns:

The prototype

setName

protected void setName(java.lang.String name)

Sets the name

Parameters:

name - The name to set

setPrototype

protected void setPrototype(Cog prototype)

Sets the prototype

Parameters:

prototype - The prototype to set

setJavaClassName

protected void setJavaClassName(java.lang.String javaClassName)

Sets the javaClassName

Parameters:

javaClassName - The javaClassName to set

setControlName

protected void setControlName(java.lang.String controlName)

Sets the controlName

Parameters:

controlName - The controlName to set

setControlScriptPath

protected void setControlScriptPath(java.lang.String controlScriptPath)

Sets the controlScriptPath

Parameters:

controlScriptPath - The controlScriptPath to set

setControlScript

protected void setControlScript(Script controlScript)

Sets the controlScript

Parameters:

controlScript - The controlScript to set