|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.metamatrix.admin.objects.MMAdminObject com.metamatrix.admin.objects.MMPropertyDefinition
public class MMPropertyDefinition
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface org.teiid.adminapi.PropertyDefinition |
---|
PropertyDefinition.RestartType |
Field Summary |
---|
Fields inherited from class com.metamatrix.admin.objects.MMAdminObject |
---|
deployed, enabled, identifier, identifierParts, name, registered |
Fields inherited from interface org.teiid.adminapi.PropertyDefinition |
---|
UNBOUNDED_VALUE |
Fields inherited from interface org.teiid.adminapi.AdminObject |
---|
DELIMITER, DELIMITER_CHAR, ESCAPED_DELIMITER, ESCAPED_WILDCARD, WILDCARD |
Constructor Summary | |
---|---|
MMPropertyDefinition(java.lang.String[] identifierParts)
Constructor. |
Method Summary | |
---|---|
java.util.Collection |
getAllowedValues()
Get the allowed values for this property. |
java.lang.Object |
getDefaultValue()
Get the default value for values of this property, or an empty String if there is no default value. |
java.lang.String |
getDescription()
Get the description of this property. |
java.lang.String |
getDisplayName()
Get the localized display name of this property. |
java.lang.String |
getPropertyType()
Get the type for values of this property. |
java.lang.String |
getPropertyTypeClassName()
Get the name of the java class that best represents the property type. |
PropertyDefinition.RestartType |
getRequiresRestart()
Get whether this property requires the system to be restarted before it takes effect. |
java.lang.String |
getValue()
Get the current value of this property. |
boolean |
isConstrainedToAllowedValues()
Return whether the value or values for this property are constrained to be only those in the AllowedValues list. |
boolean |
isExpert()
The "expert" flag is used to distinguish between features that are intended for expert users from those that are intended for normal users. |
boolean |
isMasked()
The "masked" flag is used to tell whether the value should be masked when displayed to users. |
boolean |
isModifiable()
The modifiable flag is used to identify features that may not be changed once they are set. |
boolean |
isRequired()
The "required" flag is used to identify features that require at least one value (possibly a default value) by the consumer of the property. |
void |
setAllowedValues(java.util.Collection allowedValues)
|
void |
setDefaultValue(java.lang.Object defaultValue)
|
void |
setDescription(java.lang.String description)
|
void |
setDisplayName(java.lang.String displayName)
|
void |
setExpert(boolean expert)
|
void |
setMasked(boolean masked)
|
void |
setModifiable(boolean modifiable)
|
void |
setPropertyType(java.lang.String propertyTypeAsString)
|
void |
setPropertyTypeClassName(java.lang.String propertyTypeClassName)
|
void |
setRequired(boolean required)
|
void |
setRequiresRestart(PropertyDefinition.RestartType requiresRestart)
|
void |
setValue(java.lang.String value)
|
java.lang.String |
toString()
Get MetaMatrix Object as a String |
Methods inherited from class com.metamatrix.admin.objects.MMAdminObject |
---|
buildIdentifier, buildIdentifierArray, buildIdentifierList, getCreated, getCreatedBy, getCreatedDate, getIdentifier, getIdentifierArray, getLastChangedBy, getLastChangedDate, getLastUpdated, getLastUpdatedBy, getName, getNameFromIdentifier, getParentName, getProperties, getPropertiesAsString, getPropertyValue, getProps, isEnabled, isRegistered, setCreated, setCreatedBy, setEnabled, setIdentifier, setLastUpdated, setLastUpdatedBy, setProperties, setRegistered |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.teiid.adminapi.AdminObject |
---|
getIdentifier, getName, getProperties, getPropertyValue |
Constructor Detail |
---|
public MMPropertyDefinition(java.lang.String[] identifierParts)
identifierParts
- Method Detail |
---|
public java.lang.String toString()
MMAdminObject
toString
in class MMAdminObject
Object.toString()
public java.lang.String getValue()
PropertyDefinition
getValue
in interface PropertyDefinition
PropertyDefinition.getValue()
public java.util.Collection getAllowedValues()
PropertyDefinition
getAllowedValues
in interface PropertyDefinition
PropertyDefinition.getAllowedValues()
public java.lang.Object getDefaultValue()
PropertyDefinition
getDefaultValue
in interface PropertyDefinition
PropertyDefinition.getDefaultValue()
public java.lang.String getDescription()
PropertyDefinition
getDescription
in interface PropertyDefinition
PropertyDefinition.getDescription()
public java.lang.String getDisplayName()
PropertyDefinition
getDisplayName
in interface PropertyDefinition
PropertyDefinition.getDisplayName()
public java.lang.String getPropertyType()
PropertyDefinition
getPropertyType
in interface PropertyDefinition
PropertyDefinition.getPropertyType()
public java.lang.String getPropertyTypeClassName()
PropertyDefinition
getPropertyTypeClassName
in interface PropertyDefinition
PropertyDefinition.getPropertyTypeClassName()
public PropertyDefinition.RestartType getRequiresRestart()
PropertyDefinition
getRequiresRestart
in interface PropertyDefinition
PropertyDefinition.getRequiresRestart()
public boolean isExpert()
PropertyDefinition
isExpert
in interface PropertyDefinition
PropertyDefinition.isExpert()
public boolean isMasked()
PropertyDefinition
isMasked
in interface PropertyDefinition
PropertyDefinition.isMasked()
public boolean isModifiable()
PropertyDefinition
isModifiable
in interface PropertyDefinition
PropertyDefinition.isModifiable()
public boolean isRequired()
PropertyDefinition
Whether a property is required by the consumer is unrelated to whether there is a default value, which only simplifies the task of the property provider. A property may be required, meaning it must have at least one value, but that same property definition may or may not have a default. The combination of required and whether it has a default will determine whether the user must supply a value.
isRequired
in interface PropertyDefinition
PropertyDefinition.isRequired()
public void setAllowedValues(java.util.Collection allowedValues)
allowedValues
- The allowedValues to set.public void setDefaultValue(java.lang.Object defaultValue)
defaultValue
- The defaultValue to set.public void setDescription(java.lang.String description)
description
- The description to set.public void setDisplayName(java.lang.String displayName)
displayName
- The displayName to set.public void setExpert(boolean expert)
expert
- The value of expert to set.public void setMasked(boolean masked)
masked
- The value of masked to set.public void setModifiable(boolean modifiable)
modifiable
- The value of modifiable to set.public void setPropertyType(java.lang.String propertyTypeAsString)
propertyTypeAsString
- The propertyTypeAsString to set.public void setPropertyTypeClassName(java.lang.String propertyTypeClassName)
propertyTypeClassName
- The propertyTypeName to set.public void setRequired(boolean required)
required
- The value of required to set.public void setRequiresRestart(PropertyDefinition.RestartType requiresRestart)
requiresRestart
- The value of requiresRestart to set.public void setValue(java.lang.String value)
value
- The value to set.public boolean isConstrainedToAllowedValues()
PropertyDefinition
isConstrainedToAllowedValues
in interface PropertyDefinition
PropertyDefinition.getAllowedValues()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |