com.ibm.di.config.interfaces
Interface SchemaItemConfig

All Superinterfaces:

BaseConfiguration, Serializable

All Known Implementing Classes:

SchemaItemConfigImpl

public interface SchemaItemConfig
extends BaseConfiguration

Describes an item from the schema

See Also:

SchemaConfig

Field Summary

static String	PRESENCE_OPTIONAL
static String	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

Method Summary

String	getAttributeName() Gets the attributeName attribute of the SchemaItemConfig object
ContainerConfig	getChildSchemaList() Returns the child schema
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.
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
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 interface com.ibm.di.config.interfaces.BaseConfiguration

addListener, detachFromParent, flatten, fromEntry, getBooleanParameter, getChild, getChildForPath, getChildNames, getClone, getData, getDataIterator, getDebug, getDebug, getDebugBreak, getEnabled, getFlags, getInheritsFrom, getInheritsFromRef, getIntegerParameter, getKeys, getLogEnabled, getMetamergeConfig, getModified, getName, 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, reattachToParent, 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

Field Detail

PRESENCE_REQUIRED

static final String PRESENCE_REQUIRED

See Also:

Constant Field Values

PRESENCE_OPTIONAL

static final String PRESENCE_OPTIONAL

See Also:

Constant Field Values

Method Detail

getAttributeName

String getAttributeName()

Gets the attributeName attribute of the SchemaItemConfig object

Returns:

The attributeName value

setAttributeName

void setAttributeName(String name)

Sets the attributeName attribute of the SchemaItemConfig object

Parameters:

name - The new attributeName value

getJavaClass

String getJavaClass()

Gets the java class used internally for the value

Returns:

The java class name

setJavaClass

void setJavaClass(String className)

Sets the java class name of the SchemaItemConfig object

Parameters:

className - The new java class value

getExternalSyntax

String getExternalSyntax()

Gets the externalSyntax attribute of the SchemaItemConfig object

Returns:

The externalSyntax value

setExternalSyntax

void setExternalSyntax(String syntax)

Sets the externalSyntax attribute of the SchemaItemConfig object

Parameters:

syntax - The new externalSyntax value

getPresenceFlag

String getPresenceFlag()

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

Returns:

The presence value

setPresenceFlag

void setPresenceFlag(String presence)

Sets the presence flag of the SchemaItemConfig object

Parameters:

presence - The new presence value

getSample

Object getSample()

Returns the sample value

setSample

void setSample(Object sample)

Sets the sample value

isRequired

boolean isRequired()

Returns the required setting for this schema item

Returns:

true if this item is required

getChildSchemaList

ContainerConfig getChildSchemaList()

Returns the child schema

Since:

7.0

getMinOccurrences

int getMinOccurrences()

Returns the minimum occurrences for this item.

Since:

7.0

setMinOccurrences

void setMinOccurrences(int min)

Sets the minimum occurrence for this item.

Parameters:

min -

Since:

7.0

getMaxOccurrences

int getMaxOccurrences()

Returns the minimum occurrences for this item.

Since:

7.0

setMaxOccurrences

void setMaxOccurrences(int max)

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

Parameters:

max -

Since:

7.0

isProperty

boolean isProperty()

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

Since:

7.0

setProperty

void setProperty(boolean property)

Sets the property flag for this item.

Since:

7.0

isRepeatable

boolean isRepeatable()

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

Since:

7.0

isLeaf

boolean isLeaf()

Returns true if this item is a leaf node

Since:

7.0