|
|||||||||
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.RepositoryPropertyDescriptor atg.commerce.search.refinement.RQLPropertyDescriptor
public class RQLPropertyDescriptor
A user-defined repository property descriptor that uses RQL to get a list of components as its value.
<property name="someProperty" property-type="atg.commerce.search.refinement.RQLPropertyDescriptor" data-type="list" component-item-type="someOtherItemDescriptor" repository="/path/to/Repository"> <attribute name="repository" value="/path/to/Repository"/> <attribute name="itemDescrptor" value="someOtherItemDescriptor"> <attribute name="rql" value="(someProp = true) AND (someOtherProp > ?0)" <attribute name="param0" value="someBooleanProperty"/> </property>
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
static java.lang.String |
ITEM_DESCRIPTOR_ATTRIBUTE_NAME
|
static java.lang.String |
PARAM_ATTRIBUTE_NAME_PREFIX
|
static java.lang.String |
REPOSITORY_ATTRIBUTE_NAME
|
static java.lang.String |
RQL_ATTRIBUTE_NAME
|
static java.lang.String |
sResources
|
Fields inherited from class atg.repository.RepositoryPropertyDescriptor |
---|
EMPTY_LIST, EMPTY_MAP, EMPTY_SET, FOREIGN_REPOSITORY_NAME, FOREIGN_REPOSITORY_PATH, mCollectionOrMap |
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 | |
---|---|
RQLPropertyDescriptor()
|
Method Summary | |
---|---|
RepositoryItemDescriptor |
getComponentItemDescriptor()
Gets the item descriptor to run the query against. |
java.lang.Object[] |
getParams(java.lang.Object pBean)
Get the parameters from the paramX attributes. |
java.lang.Class |
getPropertyType()
Get the property type (always a List) |
java.lang.Object |
getPropertyValue(RepositoryItemImpl pItem,
java.lang.Object pValue)
Get the property value by executing the RQL query, returning the resuls as a List. |
Repository |
getRepository()
Get the repository to run the query against. |
RepositoryView |
getRepositoryView()
Get the repository view to run the query against. |
RqlStatement |
getRqlStatement()
Get the RQL statement to run. |
boolean |
isWritable()
Is the property writable? (always false) |
void |
logDebug(java.lang.String pMessage)
|
void |
setValue(java.lang.String pString,
java.lang.Object pObject)
We override setValue to reset the repository, componentItemDesriptor, and repositoryView properties. |
Methods inherited from class atg.beans.SerializableFeatureDescriptor |
---|
copyFeatureDescriptor, getDisplayName, getDisplayNameResource, getDisplaySortString, getShortDescription, getShortDescriptionResource, getSortString, setDisplayNameResource, setShortDescriptionResource |
Methods inherited from class java.beans.FeatureDescriptor |
---|
attributeNames, getName, getValue, isExpert, isHidden, isPreferred, setDisplayName, setExpert, setHidden, setName, setPreferred, setShortDescription |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
public static final java.lang.String sResources
public static final java.lang.String REPOSITORY_ATTRIBUTE_NAME
public static final java.lang.String ITEM_DESCRIPTOR_ATTRIBUTE_NAME
public static final java.lang.String RQL_ATTRIBUTE_NAME
public static final java.lang.String PARAM_ATTRIBUTE_NAME_PREFIX
Constructor Detail |
---|
public RQLPropertyDescriptor()
Method Detail |
---|
public java.lang.Object[] getParams(java.lang.Object pBean) throws RepositoryException
RepositoryException
public Repository getRepository()
public RepositoryItemDescriptor getComponentItemDescriptor()
getComponentItemDescriptor
in class RepositoryPropertyDescriptor
public RepositoryView getRepositoryView() throws RepositoryException
RepositoryException
public RqlStatement getRqlStatement() throws RepositoryException
RepositoryException
public java.lang.Class getPropertyType()
getPropertyType
in class DynamicPropertyDescriptor
public boolean isWritable()
isWritable
in class DynamicPropertyDescriptor
public void setValue(java.lang.String pString, java.lang.Object pObject)
setValue
in class RepositoryPropertyDescriptor
public java.lang.Object getPropertyValue(RepositoryItemImpl pItem, java.lang.Object pValue)
getPropertyValue
in class RepositoryPropertyDescriptor
public void logDebug(java.lang.String pMessage)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |