com.ibm.di.config.base
Class SchemaItemConfigImpl

java.lang.Object
  com.ibm.di.config.base.BaseConfigurationImpl
      com.ibm.di.config.base.SchemaItemConfigImpl

All Implemented Interfaces:

BaseConfiguration, MetamergeConfigChangeListener, SchemaItemConfig, Serializable

public class SchemaItemConfigImpl
extends BaseConfigurationImpl
implements SchemaItemConfig

Describes the configuration of an item from a schema

See Also:

Serialized Form

Field Summary

Fields inherited from class com.ibm.di.config.base.BaseConfigurationImpl

NAME

Fields inherited from interface com.ibm.di.config.interfaces.SchemaItemConfig

PRESENCE_OPTIONAL, PRESENCE_REQUIRED

Fields inherited from interface com.ibm.di.config.interfaces.BaseConfiguration

CHILD_PATH_SEPARATOR, DISABLE_EXTPROPS, DISABLE_INHERITANCE, INHERIT_NONE, INHERIT_PARENT, ONE_LEVEL, RECURSIVE, RECURSIVE_ONELEVEL, RECURSIVE_SUBTREE, SEARCH_EXACTCASE, SEARCH_ONELEVEL, SEARCH_PARAMNAME, SEARCH_PARAMNAME_RE, SEARCH_PROPERTY, SEARCH_REGEX, SEARCH_SUBSTRING, SUBTREE

Constructor Summary

SchemaItemConfigImpl()

SchemaItemConfigImpl(Object config)

Method Summary

boolean	detachFromParent() This method removes this objects from its parent container.
String	getAttributeName() Gets the attributeName attribute of the SchemaItemConfig object
ContainerConfig	getChildSchemaList() Returns the child schema
Object	getClone() Return self clone
boolean	getEnabled() Gets the enabled attribute of this object.
String	getExternalSyntax() Gets the externalSyntax attribute of the SchemaItemConfig object
String	getJavaClass() Gets the java class used internally for the value
int	getMaxOccurrences() Returns the minimum occurrences for this item.
int	getMinOccurrences() Returns the minimum occurrences for this item.
Name	getName() The object's full name
String	getPresenceFlag() Gets the presence flag of the SchemaItemConfig object.
Object	getSample() Returns the sample value
boolean	isLeaf() Returns true if this item is a leaf node
boolean	isProperty() Returns true if this item is a property (e.g XML Element attribute)
boolean	isRepeatable() Returns true if this item is repeatable (e.g.
boolean	isRequired() Returns the required setting for this schema item
boolean	reattachToParent(int position) This method reattaches this object to its former parent.
void	setAttributeName(String name) Sets the attributeName attribute of the SchemaItemConfig object
void	setExternalSyntax(String syntax) Sets the externalSyntax attribute of the SchemaItemConfig object
void	setJavaClass(String className) Sets the java class name of the SchemaItemConfig object
void	setMaxOccurrences(int max) Sets the max occurence for this schema item.
void	setMinOccurrences(int min) Sets the minimum occurrence for this item.
void	setPresenceFlag(String presence) Sets the presence flag of the SchemaItemConfig object
void	setProperty(boolean property) Sets the property flag for this item.
void	setSample(Object sample) Sets the sample value

Methods inherited from class com.ibm.di.config.base.BaseConfigurationImpl

addListener, configurationChanged, deepClone, expandPropertyValue, expandPropertyValue, flatten, fromEntry, getBooleanParameter, getChild, getChildForPath, getChildNames, getData, getDataIterator, getDebug, getDebug, getDebugBreak, getFlags, getInheritsFrom, getInheritsFromRef, getIntegerParameter, getKeys, getLogEnabled, getLongName, getMetamergeConfig, getModified, getNamespace, getNullBehavior, getNullBehaviorValue, getNullDefinition, getNullDefinitionValue, getParameter, getParameter, getParameter, getParameterPropertySource, getParameterPropertySourceFromValue, getParameterRaw, getParent, getParentName, getPath, getReferences, getResHash, getScript, getScriptEngine, getShortName, getStringParameter, getSubstitutionMap, getUseConfigListeners, getUseListeners, getUserComment, hasParameter, init, isExpression, isParameterLocal, nameForChild, notifyChange, notifyChange, notifyChange, performNotifyChange, removeListener, removeParameter, search, search, setBooleanParameter, setChild, setData, setDebug, setDebugBreak, setEnabled, setFlags, setInheritsFrom, setInheritsFromRef, setIntegerParameter, setLogEnabled, setMetamergeConfig, setModified, setName, setName, setNullBehavior, setNullBehaviorValue, setNullDefinition, setNullDefinitionValue, setParameter, setParameter, setParameterPropertySource, setParent, setProtectedParameter, setScript, setScriptEngine, setStringParameter, setSubstitutionMap, setupInheritanceChain, setUseConfigListeners, setUseListeners, setUserComment, size, toEntry, toString, updateInheritsFrom, willExpandProps, willFlatten, willUseInherited

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ibm.di.config.interfaces.BaseConfiguration

addListener, flatten, fromEntry, getBooleanParameter, getChild, getChildForPath, getChildNames, getData, getDataIterator, getDebug, getDebug, getDebugBreak, getFlags, getInheritsFrom, getInheritsFromRef, getIntegerParameter, getKeys, getLogEnabled, getMetamergeConfig, getModified, getNamespace, getNullBehavior, getNullBehaviorValue, getNullDefinition, getNullDefinitionValue, getParameter, getParameter, getParameter, getParameterPropertySource, getParameterRaw, getParent, getPath, getReferences, getScript, getScriptEngine, getShortName, getStringParameter, getSubstitutionMap, getUseListeners, getUserComment, hasParameter, init, isExpression, isParameterLocal, nameForChild, notifyChange, notifyChange, notifyChange, removeListener, removeParameter, search, search, setBooleanParameter, setChild, setData, setDebug, setDebugBreak, setEnabled, setFlags, setInheritsFrom, setInheritsFromRef, setIntegerParameter, setLogEnabled, setMetamergeConfig, setModified, setName, setName, setNullBehavior, setNullBehaviorValue, setNullDefinition, setNullDefinitionValue, setParameter, setParameter, setParameterPropertySource, setParent, setProtectedParameter, setScript, setScriptEngine, setStringParameter, setSubstitutionMap, setupInheritanceChain, setUseListeners, setUserComment, size, toEntry, updateInheritsFrom, willFlatten

Constructor Detail

SchemaItemConfigImpl

public SchemaItemConfigImpl()

SchemaItemConfigImpl

public SchemaItemConfigImpl(Object config)

Method Detail

getAttributeName

public String getAttributeName()

Gets the attributeName attribute of the SchemaItemConfig object

Specified by:

getAttributeName in interface SchemaItemConfig

Returns:

The name of the attribute item

setAttributeName

public void setAttributeName(String name)

Sets the attributeName attribute of the SchemaItemConfig object

Specified by:

setAttributeName in interface SchemaItemConfig

Parameters:

name - The new attributeName value

getJavaClass

public String getJavaClass()

Gets the java class used internally for the value

Specified by:

getJavaClass in interface SchemaItemConfig

Returns:

The java class name

setJavaClass

public void setJavaClass(String className)

Sets the java class name of the SchemaItemConfig object

Specified by:

setJavaClass in interface SchemaItemConfig

Parameters:

className - The new java class value

getExternalSyntax

public String getExternalSyntax()

Gets the externalSyntax attribute of the SchemaItemConfig object

Specified by:

getExternalSyntax in interface SchemaItemConfig

Returns:

The externalSyntax value

setExternalSyntax

public void setExternalSyntax(String syntax)

Sets the externalSyntax attribute of the SchemaItemConfig object

Specified by:

setExternalSyntax in interface SchemaItemConfig

Parameters:

syntax - The new externalSyntax value

getPresenceFlag

public String getPresenceFlag()

Gets the presence flag of the SchemaItemConfig object. The presence flag indicates to the user whether it is required or optional.

Specified by:

getPresenceFlag in interface SchemaItemConfig

Returns:

The presence value

setPresenceFlag

public void setPresenceFlag(String presence)

Sets the presence flag of the SchemaItemConfig object

Specified by:

setPresenceFlag in interface SchemaItemConfig

Parameters:

presence - The new presence value

getSample

public Object getSample()

Returns the sample value

Specified by:

getSample in interface SchemaItemConfig

setSample

public void setSample(Object sample)

Sets the sample value

Specified by:

setSample in interface SchemaItemConfig

getClone

public Object getClone()
                throws Exception

Return self clone

Specified by:

getClone in interface BaseConfiguration

Overrides:

getClone in class BaseConfigurationImpl

Returns:

a cloned version of this object.

Throws:

Exception

detachFromParent

public boolean detachFromParent()

Description copied from class: BaseConfigurationImpl

This method removes this objects from its parent container. If this cannot be removed from the parent the contents should be cleared (default implementation) and true be returned as if it were removed. If the object cannot be cleared or removed it should return false.

Specified by:

detachFromParent in interface BaseConfiguration

Overrides:

detachFromParent in class BaseConfigurationImpl

Returns:

true if this object was removed; false if it could not be removed.

reattachToParent

public boolean reattachToParent(int position)

Description copied from class: BaseConfigurationImpl

This method reattaches this object to its former parent.

Specified by:

reattachToParent in interface BaseConfiguration

Overrides:

reattachToParent in class BaseConfigurationImpl

Returns:

true if this object was reattached; false if not;

isRequired

public boolean isRequired()

Description copied from interface: SchemaItemConfig

Returns the required setting for this schema item

Specified by:

isRequired in interface SchemaItemConfig

Returns:

true if this item is required

getChildSchemaList

public ContainerConfig getChildSchemaList()

Description copied from interface: SchemaItemConfig

Returns the child schema

Specified by:

getChildSchemaList in interface SchemaItemConfig

getMaxOccurrences

public int getMaxOccurrences()

Description copied from interface: SchemaItemConfig

Returns the minimum occurrences for this item.

Specified by:

getMaxOccurrences in interface SchemaItemConfig

getMinOccurrences

public int getMinOccurrences()

Description copied from interface: SchemaItemConfig

Returns the minimum occurrences for this item.

Specified by:

getMinOccurrences in interface SchemaItemConfig

setMaxOccurrences

public void setMaxOccurrences(int max)

Description copied from interface: SchemaItemConfig

Sets the max occurence for this schema item. -1 is unbound.

Specified by:

setMaxOccurrences in interface SchemaItemConfig

setMinOccurrences

public void setMinOccurrences(int min)

Description copied from interface: SchemaItemConfig

Sets the minimum occurrence for this item.

Specified by:

setMinOccurrences in interface SchemaItemConfig

isProperty

public boolean isProperty()

Description copied from interface: SchemaItemConfig

Returns true if this item is a property (e.g XML Element attribute)

Specified by:

isProperty in interface SchemaItemConfig

setProperty

public void setProperty(boolean property)

Description copied from interface: SchemaItemConfig

Sets the property flag for this item.

Specified by:

setProperty in interface SchemaItemConfig

getName

public Name getName()

Description copied from interface: BaseConfiguration

The object's full name

Specified by:

getName in interface BaseConfiguration

Overrides:

getName in class BaseConfigurationImpl

Returns:

the name of this object.

isRepeatable

public boolean isRepeatable()

Description copied from interface: SchemaItemConfig

Returns true if this item is repeatable (e.g. max > 1)

Specified by:

isRepeatable in interface SchemaItemConfig

isLeaf

public boolean isLeaf()

Description copied from interface: SchemaItemConfig

Returns true if this item is a leaf node

Specified by:

isLeaf in interface SchemaItemConfig

getEnabled

public boolean getEnabled()

Description copied from class: BaseConfigurationImpl

Gets the enabled attribute of this object.

Specified by:

getEnabled in interface BaseConfiguration

Overrides:

getEnabled in class BaseConfigurationImpl

Returns:

The nullBehaviorValue value.