public class RepositoryPropertyDescriptor extends DynamicPropertyDescriptor implements java.lang.Cloneable
Type | Property and Description |
---|---|
boolean |
isId
Gets the value of the property idProperty.
|
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION |
protected static java.util.List |
EMPTY_LIST |
protected static java.util.Map |
EMPTY_MAP |
protected static java.util.Set |
EMPTY_SET |
static java.lang.String |
FOREIGN_REPOSITORY_NAME
If your property descriptor refers to an item in another repository,
it can find the name of that repository by looking for a feature
descriptor attribute with this name.
|
static java.lang.String |
FOREIGN_REPOSITORY_PATH
If your property descriptor refers to an item in another repository,
it can find the path of that repository by looking for a feature
descriptor attribute with this name.
|
static java.lang.String |
IS_BACKING_MAP_PROPERTY
Attribute used to mark a property as a backing map used by the
Dynamic Properties feature
|
protected boolean |
mCollectionOrMap |
static java.lang.String |
NULL_VALUE |
PORTABLE_VALUE_KEY
BUNDLE_ATTRIBUTE_NAME, LOCALE_ATTRIBUTE_NAME
Constructor and Description |
---|
RepositoryPropertyDescriptor()
Constructs a new RepositoryPropertyDescriptor.
|
RepositoryPropertyDescriptor(RepositoryPropertyDescriptor pDescriptor) |
RepositoryPropertyDescriptor(java.lang.String pPropertyName)
Constructs a new RepositoryPropertyDescriptor.
|
RepositoryPropertyDescriptor(java.lang.String pPropertyName,
java.lang.Class pPropertyType,
java.lang.String pShortDescription)
Constructs a new RepositoryPropertyDescriptor with the given
property name, property type, and short description.
|
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone() |
static RepositoryPropertyDescriptor |
createPropertyDescriptorFromType(java.lang.String pType)
Creates a new RepositoryPropertyDescriptor of a given type.
|
java.util.List<java.lang.String> |
getAttributeNames()
Returns the names of the attributes, in no particular order.
|
boolean |
getCascadeDelete() |
boolean |
getCascadeInsert() |
boolean |
getCascadeUpdate() |
RepositoryItemDescriptor |
getComponentItemDescriptor() |
DynamicBeanInfo |
getComponentPropertyBeanInfo()
Overrides the getPropertyBeanInfo from the super type.
|
java.lang.Object |
getDefaultValue()
Returns property DefaultValue
|
java.lang.String |
getDefaultValueString() |
java.util.Map<java.lang.String,java.lang.String> |
getEnumeratedLocalizedValuesMapping(java.util.Locale pLocale)
If this is an enumerated type, return a mapping of non-localized values to localized
values for a particular locale.
|
java.lang.String[] |
getEnumeratedValues()
If this is an enumerated type, return a list of the options associated with it.
|
RepositoryItemDescriptor |
getItemDescriptor()
Get property ItemDescriptor
|
java.util.ResourceBundle |
getLocalizedResourceBundle(java.util.Locale pLocale)
Override the getResourceBundle method which is used to localize
values for this property descriptor to the user's locale.
|
DynamicBeanInfo |
getPropertyBeanInfo()
Overrides the getPropertyBeanInfo from the super type.
|
RepositoryItemDescriptor |
getPropertyItemDescriptor() |
java.lang.Object |
getPropertyValue(RepositoryItemImpl pItem,
java.lang.Object pValue)
This method is called to retrieve a read-only value for this property.
|
java.util.ResourceBundle |
getResourceBundle()
Override the getResourceBundle method which is used to localize
values for this property descriptor to the server locale.
|
java.lang.String |
getResourceBundleName()
Returns the bundle name used by this resource bundle
|
boolean |
getSecureLogging()
Get property
SecureLogging |
atg.repository.SecureLoggingFormatter |
getSecureLoggingFormatter()
Get property
SecureLoggingFormatter |
protected java.lang.String |
getSecureLoggingString(java.lang.Object pValue)
Returns masked String value if
SecureLogging is enabled, otherwise returns the String value of the object. |
java.lang.String |
getTypeName()
Returns the name used for this type in the property descriptor.
|
java.lang.Object |
getUnmodifiableDefaultValue()
Returns property UnmodifiableDefaultValue
|
java.lang.Object |
getValue(java.lang.String pAttributeName)
Retrieve a named attribute with this feature.
|
boolean |
isAssignableFrom(RepositoryPropertyDescriptor pOther)
Determine if properties of this type can be assigned values from objects
of the specified property descriptor.
|
boolean |
isCacheable()
Returns property Cacheable
|
boolean |
isCollectionOrMap() |
boolean |
isDerived()
Test property
derived |
boolean |
isDynamicallyCreated()
Test property
dynamicallyCreated |
boolean |
isIdProperty()
Gets the value of the property idProperty.
|
boolean |
isIgnoreNullValue()
Returns property IgnoreNullValue
|
boolean |
isLocalizable()
Returns whether or not the property is localizable, which is to say whether locale-based
values can be retrieved and possibly saved through this property.
|
boolean |
isLoggingDebug() |
boolean |
isMultiValued()
Convenience method for retrieving multi valued status.
|
boolean |
isPersistent()
Test property
persistent . |
boolean |
isQueryable()
Returns property Queryable
|
boolean |
isSecureLogging()
Test property
SecureLogging |
boolean |
isValidValue(java.lang.Object pPropertyValue)
Returns true if the given property value is a valid value for
this property, false otherwise.
|
boolean |
isVersionable() |
protected boolean |
isVersionableSet()
Returns true if someone explicitly specified a value for the
versionable property.
|
static void |
registerPropertyDescriptorClass(java.lang.String pType,
java.lang.Class pClass)
Adds a new type of PropertyDescriptor to repositories which support
user-defined property descriptors.
|
void |
setCacheable(boolean pCacheable)
Sets property Cacheable.
|
void |
setCascadeDelete(boolean pCascadeDelete)
Sets the property CascadeDelete.
|
void |
setCascadeInsert(boolean pCascadeInsert)
Sets the property CascadeInsert.
|
void |
setCascadeUpdate(boolean pCascadeUpdate)
Sets the property CascadeUpdate.
|
void |
setComponentItemDescriptor(RepositoryItemDescriptor pComponentItemDescriptor)
Sets the property ComponentItemDescriptor.
|
void |
setDefaultValue(java.lang.Object pDefaultValue)
Sets property DefaultValue
|
void |
setDefaultValueString(java.lang.String pDefaultValueString)
Sets the property DefaultValueString.
|
protected void |
setDerived(boolean pDerived)
Set property
derived |
void |
setDynamicallyCreated(boolean pDynamicallyCreated)
Set property
dynamicallyCreated |
void |
setIdProperty(boolean pIdProperty)
Sets the property IdProperty.
|
void |
setIgnoreNullValue(boolean pIgnoreNullValue)
Sets property IgnoreNullValue, indicating whether NULL value will be ignore for
this property.
|
void |
setItemDescriptor(RepositoryItemDescriptor pItemDescriptor)
Set property ItemDescriptor.
|
void |
setLoggingDebug(boolean pLoggingDebug)
Log operations using this property descriptor.
|
protected void |
setPersistent(boolean pPersistent)
Set property
persistent . |
void |
setPropertyItemDescriptor(RepositoryItemDescriptor pPropertyItemDescriptor)
Sets the property PropertyItemDescriptor.
|
void |
setPropertyType(java.lang.Class pPropertyType)
Sets property PropertyType: the class which this property can be
expected to have at runtime.
|
void |
setPropertyValue(RepositoryItemImpl pItem,
java.lang.Object pValue)
Sets the property of this type for the item descriptor provided.
|
void |
setQueryable(boolean pQueryable)
Sets property Queryable
|
void |
setResourceBundleName(java.lang.String pResourceBundleName)
Sets the bundle name used for this resource bundle.
|
void |
setSecureLogging(boolean pSecureLogging)
Set property
SecureLogging |
void |
setSecureLoggingFormatter(atg.repository.SecureLoggingFormatter pSecureLoggingFormatter)
Set property
SecureLoggingFormatter |
void |
setValue(java.lang.String pAttributeName,
java.lang.Object pValue)
Associate a named attribute with this feature.
|
void |
setVersionable(boolean pVersionable)
Sets the property Versionable.
|
java.lang.String |
toString()
Return a string representation of this object
|
createLocalePropertyEditor, createLocalePropertyEditor, createPropertyEditor, getComponentPropertyType, getLocale, getPropertyEditorClass, getPropertyType, getUIPropertyEditor, isReadable, isRequired, isWritable, setComponentPropertyType, setPropertyEditorClass, setReadable, setRequired, setWritable
copyFeatureDescriptor, getCurrentLocale, getDisplayName, getDisplayName, getDisplayNameResource, getDisplaySortString, getLocalizedDisplayName, getLocalizedResourceBundle, getShortDescription, getShortDescriptionResource, getSortString, setDisplayNameResource, setShortDescriptionResource
public static final java.lang.String NULL_VALUE
protected static final java.util.List EMPTY_LIST
protected static final java.util.Map EMPTY_MAP
protected static final java.util.Set EMPTY_SET
public static final java.lang.String FOREIGN_REPOSITORY_NAME
public static final java.lang.String FOREIGN_REPOSITORY_PATH
public static final java.lang.String IS_BACKING_MAP_PROPERTY
public static java.lang.String CLASS_VERSION
protected boolean mCollectionOrMap
public RepositoryPropertyDescriptor()
public RepositoryPropertyDescriptor(java.lang.String pPropertyName)
public RepositoryPropertyDescriptor(java.lang.String pPropertyName, java.lang.Class pPropertyType, java.lang.String pShortDescription)
public RepositoryPropertyDescriptor(RepositoryPropertyDescriptor pDescriptor)
public void setQueryable(boolean pQueryable)
public boolean isQueryable()
public void setCacheable(boolean pCacheable)
public boolean isCacheable()
public void setVersionable(boolean pVersionable)
pVersionable
- new value to setpublic boolean isVersionable()
protected boolean isVersionableSet()
public void setDefaultValue(java.lang.Object pDefaultValue) throws java.lang.IllegalArgumentException
java.lang.IllegalArgumentException
public java.lang.Object getDefaultValue()
public java.lang.Object getUnmodifiableDefaultValue()
public void setIdProperty(boolean pIdProperty)
pIdProperty
- new value to setpublic boolean isIdProperty()
protected void setDerived(boolean pDerived)
derived
pDerived
- the new value to setpublic boolean isDerived()
derived
derived
protected void setPersistent(boolean pPersistent)
persistent
. This is a flag indicating if this
is a persistent property.pPersistent
- new value to setpublic boolean isPersistent()
persistent
. This is a flag indicating if this
is a persistent property.persistent
public void setDynamicallyCreated(boolean pDynamicallyCreated)
dynamicallyCreated
pDynamicallyCreated
- the new value to setpublic boolean isDynamicallyCreated()
dynamicallyCreated
dynamicallyCreated
public void setSecureLogging(boolean pSecureLogging)
SecureLogging
pSecureLogging
- new value to setpublic boolean getSecureLogging()
SecureLogging
SecureLogging
public boolean isSecureLogging()
SecureLogging
SecureLogging
public atg.repository.SecureLoggingFormatter getSecureLoggingFormatter()
SecureLoggingFormatter
public void setSecureLoggingFormatter(atg.repository.SecureLoggingFormatter pSecureLoggingFormatter)
SecureLoggingFormatter
pSecureLoggingFormatter
- SecureLoggingFormatter to be setprotected java.lang.String getSecureLoggingString(java.lang.Object pValue)
SecureLogging
is enabled, otherwise returns the String value of the object.pValue
- SecureLogging
is enabled, otherwise returns the String value of the object.public boolean isValidValue(java.lang.Object pPropertyValue)
public void setIgnoreNullValue(boolean pIgnoreNullValue)
public boolean isIgnoreNullValue()
public void setDefaultValueString(java.lang.String pDefaultValueString) throws java.lang.IllegalArgumentException
You should set this after you've defined the data type for the descriptor so that the conversion can be performed correctly. In some cases, the data type is determined by the type of the column that this is associated with so make sure that the column is defined too.
pDefaultValueString
- value to setjava.lang.IllegalArgumentException
- if the conversion to the correct
data type failspublic java.lang.String getDefaultValueString()
public boolean isCollectionOrMap()
public void setPropertyType(java.lang.Class pPropertyType)
DynamicPropertyDescriptor
setPropertyType
in class DynamicPropertyDescriptor
public void setCascadeInsert(boolean pCascadeInsert)
pCascadeInsert
- new value to setpublic boolean getCascadeInsert()
public void setCascadeUpdate(boolean pCascadeUpdate)
pCascadeUpdate
- new value to setpublic boolean getCascadeUpdate()
public void setCascadeDelete(boolean pCascadeDelete)
pCascadeDelete
- new value to setpublic boolean getCascadeDelete()
public void setItemDescriptor(RepositoryItemDescriptor pItemDescriptor)
pItemDescriptor
- new value to setpublic RepositoryItemDescriptor getItemDescriptor()
public void setPropertyItemDescriptor(RepositoryItemDescriptor pPropertyItemDescriptor)
pPropertyItemDescriptor
- new value to setpublic RepositoryItemDescriptor getPropertyItemDescriptor()
public DynamicBeanInfo getPropertyBeanInfo() throws java.beans.IntrospectionException
getPropertyBeanInfo
in class DynamicPropertyDescriptor
java.beans.IntrospectionException
public DynamicBeanInfo getComponentPropertyBeanInfo() throws java.beans.IntrospectionException
getComponentPropertyBeanInfo
in class DynamicPropertyDescriptor
java.beans.IntrospectionException
public void setComponentItemDescriptor(RepositoryItemDescriptor pComponentItemDescriptor)
pComponentItemDescriptor
- new value to setpublic RepositoryItemDescriptor getComponentItemDescriptor()
public java.lang.Object getPropertyValue(RepositoryItemImpl pItem, java.lang.Object pValue)
public void setPropertyValue(RepositoryItemImpl pItem, java.lang.Object pValue)
public java.lang.String getTypeName()
public java.lang.String[] getEnumeratedValues()
public java.util.Map<java.lang.String,java.lang.String> getEnumeratedLocalizedValuesMapping(java.util.Locale pLocale)
public boolean isLocalizable()
public static RepositoryPropertyDescriptor createPropertyDescriptorFromType(java.lang.String pType)
public static void registerPropertyDescriptorClass(java.lang.String pType, java.lang.Class pClass)
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
clone
in class java.lang.Object
java.lang.CloneNotSupportedException
public boolean isMultiValued()
isMultiValued
in class DynamicPropertyDescriptor
public void setLoggingDebug(boolean pLoggingDebug)
pLoggingDebug
- new value to setpublic boolean isLoggingDebug()
public java.util.ResourceBundle getLocalizedResourceBundle(java.util.Locale pLocale)
getLocalizedResourceBundle
in class SerializableFeatureDescriptor
pLocale
- The locale to review the resource bundle for.public java.util.ResourceBundle getResourceBundle()
getResourceBundle
in class SerializableFeatureDescriptor
public java.lang.String getResourceBundleName()
public void setResourceBundleName(java.lang.String pResourceBundleName)
public java.lang.Object getValue(java.lang.String pAttributeName)
getValue
in class java.beans.FeatureDescriptor
attributeName
- The locale-independent name of the attributepublic void setValue(java.lang.String pAttributeName, java.lang.Object pValue)
setValue
in class java.beans.FeatureDescriptor
attributeName
- The locale-independent name of the attributevalue
- The value.public java.util.List<java.lang.String> getAttributeNames()
public boolean isAssignableFrom(RepositoryPropertyDescriptor pOther)
pOther
- the property descriptor defining the other type, must be
non-nulltrue
if objects of this property descriptor can be
assigned values from objects of the specified property descriptor, else
false
.public java.lang.String toString()
toString
in class SerializableFeatureDescriptor