com.ibm.di.config.base
Class ExposedPropertyImpl
java.lang.Object
com.ibm.di.config.base.BaseConfigurationImpl
com.ibm.di.config.base.ExposedPropertyImpl
- All Implemented Interfaces:
- BaseConfiguration, ExposedProperty, MetamergeConfigChangeListener, java.io.Serializable
public class ExposedPropertyImpl
- extends BaseConfigurationImpl
- implements ExposedProperty
Implementation of ExposedProperty interface.
Note: This class overrides the getName() method to reflect the current
property and store values as defined by getPropertyName() and getStoreName()
to create a unique name.
1. has property and store names --> "property.store" 2. has property but not
store name -> "property" 3. has store but not property -> "store"
- See Also:
ExposedProperty
,
Serialized Form
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 |
java.lang.String |
getCategory()
Returns the category for this property |
java.lang.String |
getLabel()
Optional label used by UI applications (use getUserComment() for
tooltips) |
javax.naming.Name |
getName()
Overridden to dynamically generate name from store and property. |
java.lang.String |
getPropertyName()
Returns the property name |
java.lang.String |
getShortName()
Overridden to dynamically generate name from store and property. |
java.lang.String |
getStoreName()
Returns the store name. |
void |
setCategory(java.lang.String category)
Changes the category for this property |
void |
setLabel(java.lang.String label)
Sets the label for this exposed property |
void |
setPropertyName(java.lang.String propertyName)
Sets the name of the exposed property |
void |
setStoreName(java.lang.String storeName)
Sets the store name to which the exposed property applies. |
Methods inherited from class com.ibm.di.config.base.BaseConfigurationImpl |
addListener, configurationChanged, deepClone, detachFromParent, expandPropertyValue, expandPropertyValue, flatten, fromEntry, getBooleanParameter, getChild, getChildForPath, getChildNames, getClone, getData, getDataIterator, getDebug, getDebug, getDebugBreak, getEnabled, getFlags, getInheritsFrom, getInheritsFromRef, getIntegerParameter, getKeys, getLogEnabled, getLongName, getMetamergeConfig, getModified, getModTS, getNamespace, getNullBehavior, getNullBehaviorValue, getNullDefinition, getNullDefinitionValue, getParameter, getParameter, getParameter, getParameterPropertySource, getParameterPropertySourceFromValue, getParameterRaw, getParent, getParentName, getPath, getReferences, getResHash, getScript, getScriptEngine, getStringParameter, getSubstitutionMap, getUseConfigListeners, getUseListeners, getUserComment, hasParameter, init, isExpression, isParameterLocal, isProtectedParameter, nameForChild, notifyChange, notifyChange, notifyChange, performNotifyChange, reattachToParent, removeListener, removeParameter, search, search, setBooleanParameter, setChild, setData, setDebug, setDebugBreak, setEnabled, setFlags, setInheritsFrom, setInheritsFromRef, setIntegerParameter, setLogEnabled, setMetamergeConfig, setModified, setModTS, setName, setName, setNullBehavior, setNullBehaviorValue, setNullDefinition, setNullDefinitionValue, setParameter, setParameter, setParameterPropertySource, setParent, setProtectedParameter, 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, detachFromParent, flatten, fromEntry, getBooleanParameter, getChild, getChildForPath, getChildNames, getClone, getData, getDataIterator, getDebug, getDebug, getDebugBreak, getEnabled, getFlags, getInheritsFrom, getInheritsFromRef, getIntegerParameter, getKeys, getLogEnabled, getMetamergeConfig, getModified, getModTS, getNamespace, getNullBehavior, getNullBehaviorValue, getNullDefinition, getNullDefinitionValue, getParameter, getParameter, getParameter, getParameterPropertySource, getParameterRaw, getParent, getPath, getReferences, getScript, getScriptEngine, getStringParameter, getSubstitutionMap, getUseListeners, getUserComment, hasParameter, init, isExpression, isParameterLocal, isProtectedParameter, nameForChild, notifyChange, notifyChange, notifyChange, reattachToParent, removeListener, removeParameter, search, search, setBooleanParameter, setChild, setData, setDebug, setDebugBreak, setEnabled, setFlags, setInheritsFrom, setInheritsFromRef, setIntegerParameter, setLogEnabled, setMetamergeConfig, setModified, setModTS, setName, setName, setNullBehavior, setNullBehaviorValue, setNullDefinition, setNullDefinitionValue, setParameter, setParameter, setParameterPropertySource, setParent, setProtectedParameter, setProtectedParameter, setScript, setScriptEngine, setStringParameter, setSubstitutionMap, setupInheritanceChain, setUseListeners, setUserComment, size, toEntry, updateInheritsFrom, willFlatten |
ExposedPropertyImpl
public ExposedPropertyImpl()
- Constructors
ExposedPropertyImpl
public ExposedPropertyImpl(java.lang.Object data)
getShortName
public java.lang.String getShortName()
- Overridden to dynamically generate name from store and property.
(non-Javadoc)
- Specified by:
getShortName
in interface BaseConfiguration
- Overrides:
getShortName
in class BaseConfigurationImpl
- Returns:
- The shortName value
- See Also:
BaseConfigurationImpl.getShortName()
getName
public javax.naming.Name getName()
- Overridden to dynamically generate name from store and property.
(non-Javadoc)
- Specified by:
getName
in interface BaseConfiguration
- Overrides:
getName
in class BaseConfigurationImpl
- Returns:
- the name of this object.
- See Also:
BaseConfigurationImpl.getName()
getCategory
public java.lang.String getCategory()
- Description copied from interface:
ExposedProperty
- Returns the category for this property
- Specified by:
getCategory
in interface ExposedProperty
- Returns:
- the category
getPropertyName
public java.lang.String getPropertyName()
- Description copied from interface:
ExposedProperty
- Returns the property name
- Specified by:
getPropertyName
in interface ExposedProperty
- Returns:
- property name
getStoreName
public java.lang.String getStoreName()
- Description copied from interface:
ExposedProperty
- Returns the store name. A property may be exposed without a store name in
which case it applies to the first store name with that property.
- Specified by:
getStoreName
in interface ExposedProperty
- Returns:
- store name or null if not defined
getLabel
public java.lang.String getLabel()
- Description copied from interface:
ExposedProperty
- Optional label used by UI applications (use getUserComment() for
tooltips)
- Specified by:
getLabel
in interface ExposedProperty
- Returns:
- tooltip
setCategory
public void setCategory(java.lang.String category)
- Description copied from interface:
ExposedProperty
- Changes the category for this property
- Specified by:
setCategory
in interface ExposedProperty
setPropertyName
public void setPropertyName(java.lang.String propertyName)
- Description copied from interface:
ExposedProperty
- Sets the name of the exposed property
- Specified by:
setPropertyName
in interface ExposedProperty
- Parameters:
propertyName
- The exposed property name
setStoreName
public void setStoreName(java.lang.String storeName)
- Description copied from interface:
ExposedProperty
- Sets the store name to which the exposed property applies. Can be null to
denote the first property store with this name.
- Specified by:
setStoreName
in interface ExposedProperty
- Parameters:
storeName
- The name of the property store or null for any property store
setLabel
public void setLabel(java.lang.String label)
- Description copied from interface:
ExposedProperty
- Sets the label for this exposed property
- Specified by:
setLabel
in interface ExposedProperty
- Parameters:
label
- Text used by UI applications