com.partnersoft.cog

Class CogCollectionType

java.lang.Object

com.partnersoft.cog.AbstractCogType

com.partnersoft.cog.CogCollectionType

All Implemented Interfaces:

Coggable, CogType, Immutable

public class CogCollectionType
extends AbstractCogType

Describes collection-like Cogs.

Copyright 2005-2009 Partner Software, Inc.

Author:

Paul Reavis, Russell Cagle

Constructor Summary

Constructors

Constructor and Description
CogCollectionType(Cog state)
CogCollectionType(java.lang.String name, java.lang.String className, java.lang.String controlType, Cog prototype, boolean sorted, boolean uniquelyNamed, java.lang.String contentType)

Method Summary

Methods

Modifier and Type	Method and Description
void	cleanStructureOf(Cog node) Cleans the given node structure as best as it can based on available information.
CogCollectionType	createParameterizedType(java.lang.String contentType) Creates a new parameterized type from this base type, by copying the state from this type and setting the contentType to the specified type name.
java.lang.String	getContentType()
boolean	isSorted()
boolean	isUniquelyNamed()
Cog	toCog() Returns the complete internal state of this object in the form of a Cog.
java.util.List<CogValidationException>	validate(Cog node) Validates the given node structure as best it can.

Methods inherited from class com.partnersoft.cog.AbstractCogType

buildForm, buildFormField, createNode, getControlName, getControlScript, getControlScriptPath, getJavaClassName, getName, getPrototype, runControlScript, setControlName, setControlScript, setControlScriptPath, setJavaClassName, setName, setPrototype, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CogCollectionType

public CogCollectionType(Cog state)

CogCollectionType

public CogCollectionType(java.lang.String name,
                 java.lang.String className,
                 java.lang.String controlType,
                 Cog prototype,
                 boolean sorted,
                 boolean uniquelyNamed,
                 java.lang.String contentType)

Method Detail

createParameterizedType

public CogCollectionType createParameterizedType(java.lang.String contentType)

Creates a new parameterized type from this base type, by copying the state from this type and setting the contentType to the specified type name. This is how CogSchema creates derived, parameterized collections via the "List-of-Foo" naming convention. The schema looks up the type "List", which should be a collection type, and calls createParameterizedType("Foo") on the result to create the "List-of-Foo" type.

cleanStructureOf

public void cleanStructureOf(Cog node)

Description copied from interface: CogType

Cleans the given node structure as best as it can based on available information. This typically involves setting the datatypes of children nodes.

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

Overrides:

validate in class AbstractCogType

Parameters:

node - node to validate

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

Overrides:

toCog in class AbstractCogType

Returns:

Cog representing the internal state of this object

isSorted

public boolean isSorted()

isUniquelyNamed

public boolean isUniquelyNamed()

getContentType

public java.lang.String getContentType()