atg.repository.dp

Class LanguageTranslation

java.lang.Object

java.beans.FeatureDescriptor

atg.beans.SerializableFeatureDescriptor

atg.repository.dp.DerivationMethodImpl

atg.repository.dp.LanguageTranslation

All Implemented Interfaces:

atg.repository.dp.Constants, atg.repository.dp.DerivationMethod, java.io.Serializable

public class LanguageTranslation
extends atg.repository.dp.DerivationMethodImpl

Language translation repository property derivation. The property derivation attempts to find a best match. First, it searches the locale keys for a match on the entire locale with a variant, then it searches for a match on the locale without a variant, and finally it searches on just the language code.

See Also:

RepositoryPropertyDescriptor, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION
protected static java.lang.String	DEFAULT_LOCALE The name of the property holding the default locale.
protected static java.lang.String	DEFAULT_PROPERTY The name of the property whose value to return if no locale specific translation is found.
static java.lang.String	DEFAULT_TRANSLATIONS_PROPERTY_NAME The name of the property that holds the translations.
protected static java.lang.String	DERIVATION_NAME The name of this derivation.
protected static java.lang.String	KEY_SERVICE_PATH The nucleus path to the LocaleService.

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_BAD_ENUMERATION_TYPE, ERR_COLLECTION_EXPRESSION_TYPE, ERR_COLLECTION_ITEM_TYPE, ERR_DP_EXP_NOT_ARRAY, ERR_DP_EXP_NOT_COLLECTION, ERR_DP_EXP_NOT_MAP, ERR_DP_EXP_NOT_SET_LIST, ERR_DP_EXP_NOT_SET_LIST_MAP, ERR_DP_EXP_REFERENCES_DP, ERR_DP_EXP_TYPE_MISMATCH, ERR_DP_NOT_SET_LIST_MAP, 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_MISSING_DERIVATION, ERR_NO_ATTRIBUTE, 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_OVERRIDE_NOT_SUPPORTED, ERR_PROP_COLLECTION_TYPE, ERR_SET_NOT_WRITABLE, PROPERTY_SEPARATOR, RECURSION_DEPTH_ATTR_NAME, RESOURCE_BUNDLE_NAME, TAG_DERIVATION, TAG_EXPRESSION

Constructor Summary

Constructors

Constructor and Description
LanguageTranslation()

Method Summary

Modifier and Type	Method and Description
protected Query	constructQuery(int pQueryType, boolean pDerivedPropertyOnLeft, boolean pCountDerivedProperty, QueryExpression pPropertyExpression, QueryExpression pOther, int pOperator, boolean pIgnoreCase, QueryExpression pMinScore, QueryExpression pSearchStringFormat, Query pItemQuery, QueryBuilder pBuilder) Constructs the query itself using given query expressions and based on the query type.
protected Query	createQuery(int pQueryType, boolean pDerivedPropertyOnLeft, boolean pCountDerivedProperty, QueryExpression pOther, int pOperator, boolean pIgnoreCase, QueryExpression pMinScore, QueryExpression pSearchStringFormat, Query pItemQuery, QueryBuilder pBuilder, atg.repository.query.PropertyQueryExpression pParentProperty, java.util.List pChildPropertyList) Create a query for this derivation.
protected Query	createTranslationsSubQueryForLocale(java.lang.String pLocale, int pQueryType, boolean pDerivedPropertyOnLeft, boolean pCountDerivedProperty, QueryExpression pOther, int pOperator, boolean pIgnoreCase, QueryExpression pMinScore, QueryExpression pSearchStringFormat, Query pItemQuery, QueryBuilder pBuilder) Builds query that checks translation items for a specified locale.
java.lang.Object	derivePropertyValue(java.lang.Object pItem) Determine the derived property value.
java.lang.Object	derivePropertyValue(RepositoryItemImpl pItem) Determine the derived property value.
java.lang.String	getDefaultLocale()
java.lang.String	getDefaultProperty()
atg.repository.dp.RepositoryKeyService	getKeyService() Returns a locale key service for derived properties.
java.util.List	getOtherUnderlyingExpressions() Return any property expressions that will be used by this derivation method and which are not already in the standard expression list.
RepositoryPropertyDescriptor	getTranslationPropertyDescriptor() Return a property descriptor for the equivalent property in the translations items
java.lang.String	getTranslationsPropertyName() If this property is null, return DEFAULT_TRANSLATIONS_PROPERTY_NAME.
boolean	isQueryable() The derivation is queryable, so always return true.
void	setDefaultLocale(java.lang.String pDefaultLocale)
void	setDefaultProperty(java.lang.String pDefaultProperty)
void	setTranslationsPropertyName(java.lang.String pTranslationsPropertyName)
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, createIsEmptyQuery, createIsNotEmptyQuery, createIsNullQuery, createPatternMatchQuery, createQuery, createReferencedByQuery, createTextSearchQuery, getAllowNoExpressions, getDerivation, getFeatureDescriptor, getPropertyDescriptor, getPropertyOrigin, getPropertyOrigin, getPropertyOrigin, getPropertyOrigin, getSupportsOverrideExpression, isEmpty, isWritable, rebuildExpression, setDerivation, setFrom, setPropertyDescriptor, setPropertyValue, setPropertyValue, validate, wrap

Methods inherited from class atg.beans.SerializableFeatureDescriptor

copyFeatureDescriptor, getCurrentLocale, getDisplayName, getDisplayName, getDisplayNameResource, getDisplaySortString, getLocalizedDisplayName, getLocalizedResourceBundle, getLocalizedResourceBundle, 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 java.lang.String CLASS_VERSION

DERIVATION_NAME

protected static final java.lang.String DERIVATION_NAME

The name of this derivation.

See Also:

Constant Field Values

DEFAULT_LOCALE

protected static final java.lang.String DEFAULT_LOCALE

The name of the property holding the default locale.

See Also:

Constant Field Values

DEFAULT_PROPERTY

protected static final java.lang.String DEFAULT_PROPERTY

The name of the property whose value to return if no locale specific translation is found.

See Also:

Constant Field Values

KEY_SERVICE_PATH

protected static final java.lang.String KEY_SERVICE_PATH

The nucleus path to the LocaleService.

See Also:

Constant Field Values

DEFAULT_TRANSLATIONS_PROPERTY_NAME

public static final java.lang.String DEFAULT_TRANSLATIONS_PROPERTY_NAME

The name of the property that holds the translations.

See Also:

Constant Field Values

Constructor Detail

LanguageTranslation

public LanguageTranslation()

Method Detail

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

getTranslationsPropertyName

public java.lang.String getTranslationsPropertyName()

If this property is null, return DEFAULT_TRANSLATIONS_PROPERTY_NAME.

Returns:

The translations property name.

setTranslationsPropertyName

public void setTranslationsPropertyName(java.lang.String pTranslationsPropertyName)

Parameters:

pTranslationsPropertyName - The translations property name that will override DEFAULT_TRANSLATIONS_PROPERTY_NAME.

getKeyService

public atg.repository.dp.RepositoryKeyService getKeyService()

Returns a locale key service for derived properties.

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 Query createQuery(int pQueryType,
                            boolean pDerivedPropertyOnLeft,
                            boolean pCountDerivedProperty,
                            QueryExpression pOther,
                            int pOperator,
                            boolean pIgnoreCase,
                            QueryExpression pMinScore,
                            QueryExpression pSearchStringFormat,
                            Query pItemQuery,
                            QueryBuilder pBuilder,
                            atg.repository.query.PropertyQueryExpression pParentProperty,
                            java.util.List pChildPropertyList)
                     throws RepositoryException

Create a query for this derivation. If the request's locale is the same as the default one in derivation definition then only default expression property is included into query. If not, the translations property is checked too.

Specified by:

createQuery in class atg.repository.dp.DerivationMethodImpl

Throws:

RepositoryException

createTranslationsSubQueryForLocale

protected Query createTranslationsSubQueryForLocale(java.lang.String pLocale,
                                                    int pQueryType,
                                                    boolean pDerivedPropertyOnLeft,
                                                    boolean pCountDerivedProperty,
                                                    QueryExpression pOther,
                                                    int pOperator,
                                                    boolean pIgnoreCase,
                                                    QueryExpression pMinScore,
                                                    QueryExpression pSearchStringFormat,
                                                    Query pItemQuery,
                                                    QueryBuilder pBuilder)
                                             throws RepositoryException

Builds query that checks translation items for a specified locale.

Parameters:

pLocale - locale key to retrieve corresponding translation

pQueryType - the type of the original query

pDerivedPropertyOnLeft - if true the derived property is used as the left hand side in the query and pOtherExpression is used as the right hand side. If false the derived property is used as the right hand side and pOtherExpression is used as the left hand side.

pCountDerivedProperty - if true the derived property is used in a count query expression

pOther - the other expression involved in binary queries

pOperator - the binary operator involved in binary queries

pIgnoreCase - whether to ignore case in pattern match queries

pMinScore - min score for text queries

pSearchStringFormat - search string format for text queries

pItemQuery - query to use in includes item queries only

pBuilder - query builder to use

Returns:

query that checks translation items for a specified locale

Throws:

RepositoryException - Should an issue happen creating the query.

constructQuery

protected Query constructQuery(int pQueryType,
                               boolean pDerivedPropertyOnLeft,
                               boolean pCountDerivedProperty,
                               QueryExpression pPropertyExpression,
                               QueryExpression pOther,
                               int pOperator,
                               boolean pIgnoreCase,
                               QueryExpression pMinScore,
                               QueryExpression pSearchStringFormat,
                               Query pItemQuery,
                               QueryBuilder pBuilder)
                        throws RepositoryException

Constructs the query itself using given query expressions and based on the query type.

Parameters:

pQueryType - the type of the original query

pDerivedPropertyOnLeft - if true the derived property is used as the left hand side in the query and pOtherExpression is used as the right hand side. If false the derived property is used as the right hand side and pOtherExpression is used as the left hand side.

pCountDerivedProperty - if true the derived property is used in a count query expression

pPropertyExpression - the first expression involved in binary queries

pOther - the other expression involved in binary queries

pOperator - the binary operator involved in binary queries

pIgnoreCase - whether to ignore case in pattern match queries

pMinScore - min score for text queries

pSearchStringFormat - search string format for text queries

pItemQuery - query to use in includes item queries only

pBuilder - query builder to use

Returns:

The query.

Throws:

RepositoryException - Should an issue happen creating the query.

derivePropertyValue

public java.lang.Object derivePropertyValue(RepositoryItemImpl pItem)
                                     throws RepositoryException

Determine the derived property value.

Parameters:

pItem - the item whose property value is desired.

Returns:

The derived property value.

Throws:

RepositoryException

derivePropertyValue

public java.lang.Object derivePropertyValue(java.lang.Object pItem)
                                     throws RepositoryException

Determine the derived property value.

Parameters:

pItem - the item whose property value is desired.

Returns:

The translation if one is available.

Throws:

RepositoryException

isQueryable

public boolean isQueryable()

The derivation is queryable, so always return true.

Returns:

Always returns true.

getOtherUnderlyingExpressions

public java.util.List getOtherUnderlyingExpressions()

Return any property expressions that will be used by this derivation method and which are not already in the standard expression list. Should be overridden by subclasses.

Overrides:

getOtherUnderlyingExpressions in class atg.repository.dp.DerivationMethodImpl

Returns:

any other underlying property expressions

getTranslationPropertyDescriptor

public RepositoryPropertyDescriptor getTranslationPropertyDescriptor()

Return a property descriptor for the equivalent property in the translations items

Returns:

the translation property descriptor