atg.repository
Class TranslationDescriptor

java.lang.Object
  extended by java.beans.FeatureDescriptor
      extended by atg.beans.SerializableFeatureDescriptor
          extended by atg.repository.dp.DerivationMethodImpl
              extended by atg.repository.TranslationDescriptor
All Implemented Interfaces:
atg.repository.dp.Constants, atg.repository.dp.DerivationMethod, java.io.Serializable

public class TranslationDescriptor
extends atg.repository.dp.DerivationMethodImpl

Translation repository property description.

See Also:
RepositoryPropertyDescriptor, Serialized Form

Field Summary
static java.lang.String CLASS_VERSION
          Class version string
protected static java.lang.String DEFAULT_LOCALE
           
protected static java.lang.String DEFAULT_PROPERTY
           
protected static java.lang.String DERIVATION_NAME
           
protected static java.lang.String KEY_SERVICE_PATH
           
protected static java.lang.String STORE_CONFIGURATION_CONTAINER_PATH
           
protected static java.lang.String STORE_ID_PROPERTY_NAME
           
protected static java.lang.String TRANSLATIONS_PROPERTY_NAME
           
protected static java.lang.String USE_STORE_DEFAULT_LOCALE
           
 
Fields inherited from class atg.repository.dp.DerivationMethodImpl
COMPARISON_QUERY, INCLUDES_ALL_QUERY, INCLUDES_ANY_QUERY, INCLUDES_ITEM_QUERY, INCLUDES_QUERY, IS_NULL_QUERY, PATTERN_MATCH_QUERY, sZero, TEXT_SEARCH_QUERY
 
Fields inherited from class atg.beans.SerializableFeatureDescriptor
BUNDLE_ATTRIBUTE_NAME, LOCALE_ATTRIBUTE_NAME
 
Fields inherited from interface atg.repository.dp.Constants
ATTR_METHOD, ATTR_OVERRIDE_PROPERTY, ATTR_USER_METHOD, DEFAULT_METHOD_NAME, DEFAULT_RECURSION_DEPTH, DP_COUNT_ATTR_NAME, ERR_COLLECTION_EXPRESSION_TYPE, ERR_COLLECTION_ITEM_TYPE, ERR_DP_EXP_NOT_ARRAY, ERR_DP_EXP_NOT_COLLECTION, ERR_DP_EXP_NOT_SET_LIST, ERR_DP_EXP_REFERENCES_DP, ERR_DP_QUERYABLE_OP_NOT, ERR_DP_READABLE_OP_NOT, ERR_DP_WRITABLE_OP_NOT, ERR_DP_WRITABLE_WITH_NULL_OP, ERR_EMPTY_EXPRESSION, ERR_EXACTLY_ONE_EXPRESSION, ERR_INCOMPATIBLE_DP_EXP, ERR_INCOMPATIBLE_OP, ERR_INVALID_OVERRIDE_PROPERTY_NAME, ERR_INVALID_PROPERTY, ERR_METHOD_AND_USER_METHOD, ERR_NO_DP, ERR_NO_EXP, ERR_NO_EXPRESSION, ERR_NO_METHOD, ERR_NO_PROPERTY_FOR_LOCALE, ERR_NO_PROPERTY_TYPE, ERR_NO_SET_LIST, ERR_NULL_ITEM_DESCRIPTOR, ERR_OP_SAME_AS_DP, ERR_PROP_COLLECTION_TYPE, ERR_SET_NOT_WRITABLE, PROPERTY_SEPARATOR, RECURSION_DEPTH_ATTR_NAME, RESOURCE_BUNDLE_NAME, TAG_DERIVATION, TAG_EXPRESSION
 
Constructor Summary
TranslationDescriptor()
           
 
Method Summary
protected  atg.repository.Query createQuery(int pQueryType, boolean pDerivedPropertyOnLeft, boolean pCountDerivedProperty, atg.repository.QueryExpression pOther, int pOperator, boolean pIgnoreCase, atg.repository.QueryExpression pMinScore, atg.repository.QueryExpression pSearchStringFormat, atg.repository.Query pItemQuery, atg.repository.QueryBuilder pBuilder, atg.repository.query.PropertyQueryExpression pParentProperty, java.util.List pChildPropertyList)
          Create a query for this derivation.
 java.lang.Object derivePropertyValue(java.lang.Object pItem)
          Determine the derived property value.
 java.lang.Object derivePropertyValue(atg.repository.RepositoryItemImpl pItem)
          Determine the derived property value.
 java.lang.String getDefaultLocale()
           
 java.lang.String getDefaultProperty()
           
 atg.repository.dp.RepositoryKeyService getKeyService()
           
 InternationalizationStoreConfigurationContainer getStoreConfigurationContainer()
           
 boolean isQueryable()
          Since this derivation is not queryable, this returns null.
 boolean isUseStoreDefaultLocale()
           
 void setDefaultLocale(java.lang.String pDefaultLocale)
           
 void setDefaultProperty(java.lang.String pDefaultProperty)
           
 void setStoreConfigurationContainer(InternationalizationStoreConfigurationContainer pStoreConfigurationContainer)
           
 void setUseStoreDefaultLocale(boolean pUseStoreDefaultLocale)
           
 void setValue(java.lang.String pAttributeName, java.lang.Object pValue)
          This operation sets the attribute values.
 
Methods inherited from class atg.repository.dp.DerivationMethodImpl
createComparisonQuery, createExpression, createIncludesAllQuery, createIncludesAnyQuery, createIncludesItemQuery, createIncludesQuery, createIsNullQuery, createPatternMatchQuery, createQuery, createReferencedByQuery, createTextSearchQuery, getAllowNoExpressions, getDerivation, getFeatureDescriptor, getPropertyDescriptor, getPropertyOrigin, getPropertyOrigin, getPropertyOrigin, getPropertyOrigin, isEmpty, isWritable, rebuildExpression, setDerivation, setFrom, setPropertyDescriptor, setPropertyValue, setPropertyValue, validate, wrap
 
Methods inherited from class atg.beans.SerializableFeatureDescriptor
copyFeatureDescriptor, getDisplayName, getDisplayNameResource, getDisplaySortString, getResourceBundle, getShortDescription, getShortDescriptionResource, getSortString, setDisplayNameResource, setShortDescriptionResource, toString
 
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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION
Class version string

See Also:
Constant Field Values

DERIVATION_NAME

protected static final java.lang.String DERIVATION_NAME
See Also:
Constant Field Values

DEFAULT_LOCALE

protected static final java.lang.String DEFAULT_LOCALE
See Also:
Constant Field Values

DEFAULT_PROPERTY

protected static final java.lang.String DEFAULT_PROPERTY
See Also:
Constant Field Values

KEY_SERVICE_PATH

protected static final java.lang.String KEY_SERVICE_PATH
See Also:
Constant Field Values

TRANSLATIONS_PROPERTY_NAME

protected static final java.lang.String TRANSLATIONS_PROPERTY_NAME
See Also:
Constant Field Values

USE_STORE_DEFAULT_LOCALE

protected static final java.lang.String USE_STORE_DEFAULT_LOCALE
See Also:
Constant Field Values

STORE_CONFIGURATION_CONTAINER_PATH

protected static final java.lang.String STORE_CONFIGURATION_CONTAINER_PATH
See Also:
Constant Field Values

STORE_ID_PROPERTY_NAME

protected static final java.lang.String STORE_ID_PROPERTY_NAME
See Also:
Constant Field Values
Constructor Detail

TranslationDescriptor

public TranslationDescriptor()
Method Detail

getStoreConfigurationContainer

public InternationalizationStoreConfigurationContainer getStoreConfigurationContainer()
Returns:
store configuration container

setStoreConfigurationContainer

public void setStoreConfigurationContainer(InternationalizationStoreConfigurationContainer pStoreConfigurationContainer)
Parameters:
pStoreConfigurationContainer - store configuration container

getDefaultLocale

public java.lang.String getDefaultLocale()
Returns:
The default locale to use if a translation is not found for the request locale

setDefaultLocale

public void setDefaultLocale(java.lang.String pDefaultLocale)
Parameters:
pDefaultLocale - The default locale to use if a translation is not found for the request locale

getDefaultProperty

public java.lang.String getDefaultProperty()
Returns:
The name of the property whose value to return if no translation is found

setDefaultProperty

public void setDefaultProperty(java.lang.String pDefaultProperty)
Parameters:
pDefaultProperty - The name of the property whose value to return if no translation is found

isUseStoreDefaultLocale

public boolean isUseStoreDefaultLocale()
Returns:
boolean indicating if the country-store's default locale should be used in determining what translation to return

setUseStoreDefaultLocale

public void setUseStoreDefaultLocale(boolean pUseStoreDefaultLocale)
Parameters:
pUseStoreDefaultLocale - boolean indicating if the country-store's default locale should be used in determining what translation to return

getKeyService

public atg.repository.dp.RepositoryKeyService getKeyService()
Returns:
RepositoryKeyService The service for which we will get the locale to use to access the proper translation

setValue

public void setValue(java.lang.String pAttributeName,
                     java.lang.Object pValue)
This operation sets the attribute values.

Overrides:
setValue in class java.beans.FeatureDescriptor
Parameters:
pAttributeName - Name of the attribute.
pValue - Value to be set to the attribute.

createQuery

protected atg.repository.Query createQuery(int pQueryType,
                                           boolean pDerivedPropertyOnLeft,
                                           boolean pCountDerivedProperty,
                                           atg.repository.QueryExpression pOther,
                                           int pOperator,
                                           boolean pIgnoreCase,
                                           atg.repository.QueryExpression pMinScore,
                                           atg.repository.QueryExpression pSearchStringFormat,
                                           atg.repository.Query pItemQuery,
                                           atg.repository.QueryBuilder pBuilder,
                                           atg.repository.query.PropertyQueryExpression pParentProperty,
                                           java.util.List pChildPropertyList)
                                    throws atg.repository.RepositoryException
Create a query for this derivation. Since this derivation is not queryable, this returns null.

Specified by:
createQuery in class atg.repository.dp.DerivationMethodImpl
Throws:
atg.repository.RepositoryException

derivePropertyValue

public java.lang.Object derivePropertyValue(atg.repository.RepositoryItemImpl pItem)
                                     throws atg.repository.RepositoryException
Determine the derived property value.

Parameters:
pItem - the item whose property value is desired
Throws:
atg.repository.RepositoryException

derivePropertyValue

public java.lang.Object derivePropertyValue(java.lang.Object pItem)
                                     throws atg.repository.RepositoryException
Determine the derived property value.

Parameters:
pItem - the item whose property value is desired
Throws:
atg.repository.RepositoryException

isQueryable

public boolean isQueryable()
Since this derivation is not queryable, this returns null.