|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.beans.FeatureDescriptor atg.beans.SerializableFeatureDescriptor atg.beans.DynamicPropertyDescriptor atg.repository.search.MetaProperty
public class MetaProperty
The Property class provides the information necessary for the UI to display a property that is available.
Nested Class Summary | |
---|---|
class |
MetaProperty.MetaPropertyValue
Inner class to represent a valid indexed value for this meta property in the search index. |
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
static ApplicationLoggingImpl |
log
Logger |
Fields inherited from class atg.beans.DynamicPropertyDescriptor |
---|
PORTABLE_VALUE_KEY |
Fields inherited from class atg.beans.SerializableFeatureDescriptor |
---|
BUNDLE_ATTRIBUTE_NAME, LOCALE_ATTRIBUTE_NAME |
Constructor Summary | |
---|---|
MetaProperty(DynamicPropertyDescriptor pDpd,
java.lang.String pTypeString)
Create a new Property with the given descriptor. |
Method Summary | |
---|---|
java.beans.PropertyEditor |
createLocalePropertyEditor(java.util.Locale pLocale)
Returns a localized PropertyEditor. |
java.beans.PropertyEditor |
createPropertyEditor()
Returns a PropertyEditor which exposes the possible enumerated values through the tags property
of the PropertyEditor |
boolean |
equals(java.lang.Object pOther)
Compare other object for equality. |
java.lang.String |
getDisplayName()
Returns the potentially localized display name of the property. |
java.lang.String |
getDisplayName(java.util.Locale pLocale)
|
java.lang.String |
getDisplayValue(java.lang.String pValue)
Method to get a UI display String for a given String search engine indexed value. |
java.lang.String |
getDisplayValue(java.lang.String pValue,
java.util.Locale pLocale)
|
java.util.Map<java.lang.String,MetaProperty.MetaPropertyValue> |
getIndexedValuesMap()
Gets the map of indexed values to display names for this meta property or null if this is not known |
protected java.util.Locale |
getLocale()
Gets the Locale to use if one is not passed in to another method. |
java.lang.String |
getLocalPropertyDescriptorDisplayName(SerializableFeatureDescriptor pProp,
java.util.Locale pLocale)
Gets the localized display name for a dynamic property descriptor. |
MetaPropertyFormatter |
getMetaPropertyFormatter()
Gets the formatter for the name and display name of this meta property, may be null |
MetaPropertyValueFormatter |
getMetaPropertyValueFormatter()
Gets the formatter to display values of this meta property |
java.lang.String |
getName()
|
java.lang.String |
getOutputName()
Gets the optional explicit string output name of the property. |
DynamicPropertyDescriptor[] |
getParentPropertyDescriptors()
Gets the parent property descriptors. |
DynamicPropertyDescriptor |
getPropertyDescriptor()
Gets the original property descriptor. |
protected java.util.ResourceBundle |
getResourceBundle(java.util.Locale pLocale)
Gets the ResourceBundle for the given locale. |
protected java.lang.String |
getResourceBundleName()
Gets the resource bundle name to look up values and property name. |
atg.repository.search.indexing.specifier.PropertyTypeEnum |
getTypeEnum()
Gets the PropertyTypeEnum the property. |
java.lang.String |
getTypeString()
Gets the string type of the property. |
int |
hashCode()
Get the hash code for this Property. |
boolean |
isRankedDynamically()
|
boolean |
isRepositoryIdProperty()
Boolean method, returns true if values of this meta property are repository ids |
void |
setMetaPropertyFormatter(MetaPropertyFormatter pMetaPropertyFormatter)
|
void |
setMetaPropertyValueFormatter(MetaPropertyValueFormatter pMetaPropertyValueFormatter)
|
void |
setMetaPropertyValues(java.lang.String[] pIndexedValues,
java.lang.String[] pIndexedDisplayValues)
If the total set of valid values in the search engine index is available then it can be set here. |
void |
setOutputName(java.lang.String pOutputName)
|
void |
setParentPropertyDescriptors(DynamicPropertyDescriptor[] pParentPropertyDescriptors)
|
void |
setPropertyDescriptor(DynamicPropertyDescriptor pPropertyDescriptor)
|
void |
setRankedDynamically(boolean pRankedDynamically)
|
void |
setTypeString(java.lang.String pTypeString)
|
java.lang.String |
toString()
Return a String representation of this Property. |
Methods inherited from class java.beans.FeatureDescriptor |
---|
attributeNames, getValue, isExpert, isHidden, isPreferred, setDisplayName, setExpert, setHidden, setName, setPreferred, setShortDescription, setValue |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
public static ApplicationLoggingImpl log
Constructor Detail |
---|
public MetaProperty(DynamicPropertyDescriptor pDpd, java.lang.String pTypeString)
Method Detail |
---|
public java.lang.String getTypeString()
public void setTypeString(java.lang.String pTypeString)
public atg.repository.search.indexing.specifier.PropertyTypeEnum getTypeEnum()
public java.lang.String getOutputName()
public void setOutputName(java.lang.String pOutputName)
public DynamicPropertyDescriptor getPropertyDescriptor()
public void setPropertyDescriptor(DynamicPropertyDescriptor pPropertyDescriptor)
public DynamicPropertyDescriptor[] getParentPropertyDescriptors()
public void setParentPropertyDescriptors(DynamicPropertyDescriptor[] pParentPropertyDescriptors)
public MetaPropertyFormatter getMetaPropertyFormatter()
public void setMetaPropertyFormatter(MetaPropertyFormatter pMetaPropertyFormatter)
public MetaPropertyValueFormatter getMetaPropertyValueFormatter()
public void setMetaPropertyValueFormatter(MetaPropertyValueFormatter pMetaPropertyValueFormatter)
public java.util.Map<java.lang.String,MetaProperty.MetaPropertyValue> getIndexedValuesMap()
public boolean isRankedDynamically()
public void setRankedDynamically(boolean pRankedDynamically)
public java.lang.String getDisplayName()
SerializableFeatureDescriptor
getDisplayName
in class SerializableFeatureDescriptor
pLocale
- Optional java locale to resource display name with.
Creates a localized display name based on the property hierarchy.
e.g. ancestorCategories.displayName involves two properties
"ancestorCategories" and "displayName". They will be combined and
resources looked up to form a string like "Ancestor Categories -> Name"
public java.lang.String getDisplayName(java.util.Locale pLocale)
public java.lang.String getLocalPropertyDescriptorDisplayName(SerializableFeatureDescriptor pProp, java.util.Locale pLocale)
pProp
- SerializableFeatureDescriptor to get display namepLocale
- Optional Java Locale
public java.lang.String getName()
getName
in class java.beans.FeatureDescriptor
Creates a full name based on the property hierarchy.
e.g. ancestorCategories.displayName involves two MetaProperties
"ancestorCategories" and "displayName".
public java.beans.PropertyEditor createPropertyEditor()
tags
property
of the PropertyEditor
createPropertyEditor
in class DynamicPropertyDescriptor
public java.beans.PropertyEditor createLocalePropertyEditor(java.util.Locale pLocale)
createLocalePropertyEditor
in class DynamicPropertyDescriptor
pLocale
- the Locale for which the localized editor should be
created, or null for the default locale.public void setMetaPropertyValues(java.lang.String[] pIndexedValues, java.lang.String[] pIndexedDisplayValues)
pIndexedValues
- String array of indexed valuespIndexedDisplayValues
- String array of UI display names or resource keys for each indexed valuepublic java.lang.String getDisplayValue(java.lang.String pValue)
pValue
- String value as stored in the index
public java.lang.String getDisplayValue(java.lang.String pValue, java.util.Locale pLocale)
public boolean isRepositoryIdProperty()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object pOther)
equals
in class java.lang.Object
public java.lang.String toString()
toString
in class SerializableFeatureDescriptor
protected java.util.Locale getLocale()
getLocale
in class DynamicPropertyDescriptor
protected java.lang.String getResourceBundleName()
protected java.util.ResourceBundle getResourceBundle(java.util.Locale pLocale)
pLocale
- Locale to use
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |