de.hybris.platform.jalo.type

Class ViewType

java.lang.Object

de.hybris.platform.util.BridgeAbstraction

de.hybris.platform.jalo.Item

de.hybris.platform.jalo.ExtensibleItem

de.hybris.platform.jalo.c2l.LocalizableItem

de.hybris.platform.jalo.type.TypeManagerManaged

de.hybris.platform.jalo.type.Type

de.hybris.platform.jalo.type.ComposedType

de.hybris.platform.jalo.type.ViewType

All Implemented Interfaces:

Serializable, Comparable

public class ViewType
extends ComposedType

Represents the funtionality of a 'SQL-View'. Visit wiki.hybris.de for more informations.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.jalo.type.ComposedType

ComposedType.ComposedTypeImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.type.Type

Type.TypeImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.type.TypeManagerManaged

TypeManagerManaged.TypeManagerManagedImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

LocalizableItem.LocalizableItemImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.ExtensibleItem

ExtensibleItem.ExtensibleItemImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.Item

Item.AttributeFilter, Item.AttributeMode, Item.CachedGetter, Item.CachedSetter, Item.ItemAttributeMap, Item.ItemConstraint, Item.ItemImpl, Item.JaloCachedComputationException

Field Summary

Fields

Modifier and Type	Field and Description
static String	COLUMNS
static String	PARAMS
static String	QUERY

Fields inherited from class de.hybris.platform.jalo.type.ComposedType

ABSTRACT, ALLSUBTYPES, ALLSUPERTYPES, ATTRIBUTEDESCRIPTORS, DECLAREDATTRIBUTEDESCRIPTORS, DUMPPROPERTYTABLE, DYNAMIC, INHERITANCEPATH, INHERITEDATTRIBUTEDESCRIPTORS, JALOCLASS, JALOONLY, JNDINAME, SINGLETON, SUBTYPES, SUPERTYPE, TABLE

Fields inherited from class de.hybris.platform.jalo.type.Type

CODE, DEFAULTVALUE, DESCRIPTION, XMLDEFINITION

Fields inherited from class de.hybris.platform.jalo.type.TypeManagerManaged

AUTOCREATE, DEPRECATED, EXTENSION_NAME, GENERATE, NAME

Fields inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

LANGUAGE_FALLBACK_ENABLED

Fields inherited from class de.hybris.platform.jalo.Item

_CREATION_TIME_INTERNAL, _MODIFIED_TIME_INTERNAL, accessorLog, CREATION_TIME, DISABLE_ATTRIBUTE_CHECK, DISABLE_ITEMCHECK_BEFORE_REMOVABLE, EVEN, FEATURE_ACCESSMAP_QUALIFIER, INITIAL_CREATION_FLAG, isJaloOnly, MODIFIED_TIME, NEGATIVE, NOT_FOUND, OWNER, PK, POSITIVE, SAVE_FROM_SERVICE_LAYER, staticTransientObjects, TYPE

Fields inherited from class de.hybris.platform.util.BridgeAbstraction

impl, tenant

Constructor Summary

Constructors

Constructor and Description
ViewType()

Method Summary

Modifier and Type	Method and Description
Map	convertGenericValueConditions(GenericCondition cond)
protected Map	createAttributeMapFromRow(List resultAttributes, List rowData)
protected Item	createItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes) The generic creator method for creating new composed types by ComposedType.newInstance(Map).
List	getColumnAttributeDescriptors()
Class	getJaloClass() Redefined to return ViewResultItem class.
Set	getParamAttributeDescriptors()
String	getQuery()
protected List	getResultRowSignature(List resultRowAttributes)
protected Map	getXMLCustomProperties(String forExtension) Exports its query as XML custom properties.
boolean	isAbstract() redefined to return true always.
Object	parseValue(SessionContext ctx, String value)
SearchResult	search(Map values, boolean dontNeedTotal, int start, int count)
SearchResult	search(SessionContext ctx, Map values, boolean dontNeedTotal, int start, int count)
protected void	setColumnAttributeDescriptors(List cols) Changes the current column attribute descriptor list.
protected void	setParamAttributeDescriptors(Set params) Changes the current param attribute descriptor set.
void	setQuery(String q) Changes the flexible search query of this view type.
String	toString(SessionContext ctx, Object value)

Methods inherited from class de.hybris.platform.jalo.type.ComposedType

_sortAttributesByQualifier, checkItemPermission, checkTypePermission, checkTypePermission, createAttributeDescriptor, createAttributeDescriptor, createJaloOnlyInstance, exportXMLDefinition, exportXMLDefinition, getAllConcreteItemTypeCodes, getAllDefaultValues, getAllDefaultValues, getAllInstances, getAllInstances, getAllInstancesCount, getAllSubTypes, getAllSuperTypes, getAttributeDescriptor, getAttributeDescriptorIncludingPrivate, getAttributeDescriptors, getAttributeDescriptorsIncludingPrivate, getAttributeDescriptorsIncludingPrivate, getComposedTypeImpl, getCreatorInstance, getDeclaredAttributeDescriptor, getDeclaredAttributeDescriptors, getDeclaredJaloClass, getDefaultValues, getDefaultValues, getDumpPropertyTable, getEveryAttributeDescriptor, getInheritancePathString, getInheritedAttributeDescriptors, getInitialAttributeDescriptors, getItemTypeCode, getJNDIName, getNonInitialAttributes, getPartOfAutoRemovalAttributeDescriptors, getRelations, getSingletonInstance, getSubTypes, getSuperType, getTable, getXMLDefinition, getXMLDefinition, hasAttribute, isAssignableFrom, isDynamic, isInstance, isJaloClassAbstract, isJaloOnly, isSameOrSuperTypeOf, isSingleton, newInstance, newInstance, newInstance, newInstance, newInstance, newInstance, setDeclaredAttributeDescriptors, setJaloClass, setJaloOnly, setSingleton, setTypeSearchSessionContex, toString, unsetTypeSearchContext

Methods inherited from class de.hybris.platform.jalo.type.Type

compareTo, getAllDescriptions, getAllDescriptions, getCode, getDefaultValue, getDefaultValue, getDescription, getDescription, getTypeImpl, setAllDescriptions, setAllDescriptions, setDefaultValue, setDefaultValue, setDescription, setDescription

Methods inherited from class de.hybris.platform.jalo.type.TypeManagerManaged

getAllNames, getAllNames, getExtensionName, getImpl, getName, getName, isAutocreate, isDeprecated, isGenerate, setAllNames, setAllNames, setAutocreate, setExtensionName, setGenerate, setName, setName

Methods inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

getAllLocalizedProperties, getAllLocalizedProperties, getAllLocalizedProperties, getAllLocalizedProperties, getAllValuesSessionContext, getLocalizedProperty, getLocalizedProperty, getLocalizedPropertyInternal, getLocalizedPropertyNames, getLocalizedPropertyNames, hasLanguage, isEmptyValue, isFallbackEnabled, removeLocalizedProperty, removeLocalizedProperty, setAllLocalizedProperties, setAllLocalizedProperties, setLocalizedProperty, setLocalizedProperty

Methods inherited from class de.hybris.platform.jalo.ExtensibleItem

createNonClassAccessor, getAllProperties, getAllProperties, getProperty, getProperty, getPropertyNames, getPropertyNames, removeProperty, removeProperty, setAllProperties, setAllProperties, setProperty, setProperty

Methods inherited from class de.hybris.platform.jalo.Item

addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addNegativePermission, addPermission, addPositivePermission, assureExtensionsLoaded, changeTypeAfterCreation, checkConstraint, checkMandatoryAttribute, checkMandatoryAttribute, checkPermission, checkPermission, checkRemovable, clearPermission, ctx, doAfterRemove, doBeforeRemove, equals, getAccessorFor, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributesInternal, getAllLinkedItems, getAndCheckCacheBoundItem, getAttribute, getAttribute, getCacheBoundItem, getComposedType, getComposedTypePK, getCreationTime, getCurrentlyRemovingCount, getDefaultAttributeModes, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItemsCount, getLinkedItemsCount, getLinkedItemsCount, getModificationTime, getNegativePermissions, getOwner, getPermissionMap, getPermissions, getPersistenceVersion, getPK, getPositivePermissions, getRestrictedPrincipals, getSession, getSyncObject, getTenant, getTransientObject, getTransientObjectMap, hashCode, hasRegisteredClassAccessorFor, internal_registerClassAccessorFor, internal_registerNonClassAccessorFor, invalidateLocalCaches, isAlive, isCacheBound, isCurrentlyRemoving, isCurrentlyRemoving, isEmptyRelationValue, isInCreate, isInstanceOf, isItemCheckBeforeRemoveableDisabled, isRelationLocalizationFallbackEnabled, newInstance, notifyExtensionsAfterItemCreation, notifyExtensionsBeforeItemCreation, notifyItemRemoval, readResolve, refreshRemote, registerAccessFor, registerAccessFor, registerJaloInvalidationListeners, remove, remove, removeItemCollection, removeItemCollection, removeLinkedItems, removeLinkedItems, removeLinkedItems, removeLinkedItems, removeLinks, removePartOfItems, removePartOfItems, setAllAttributes, setAllAttributes, setAllAttributesInternal, setAllLinkedItems, setAllLinkedItems, setAllLinkedItems, setAllLinkedItems, setAttribute, setAttribute, setAttributeFromString, setAttributeFromString, setCacheBound, setComposedType, setCreationTime, setImplementation, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setModificationTime, setNonInitialAttributes, setOwner, setPermissionsByMap, setTransientObject, setUseTA, useTA, writeReplace

Methods inherited from class de.hybris.platform.util.BridgeAbstraction

getImplementation, setTenant

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

QUERY

public static final String QUERY

See Also:

Constant Field Values

COLUMNS

public static final String COLUMNS

See Also:

Constant Field Values

PARAMS

public static final String PARAMS

See Also:

Constant Field Values

Constructor Detail

ViewType

public ViewType()

Method Detail

createItem

protected Item createItem(SessionContext ctx,
                          ComposedType type,
                          Item.ItemAttributeMap allAttributes)
                   throws JaloBusinessException

Description copied from class: ComposedType

The generic creator method for creating new composed types by ComposedType.newInstance(Map).

Required attributes are:

• ComposedType.SUPERTYPE
• Type.CODE

Overrides:

createItem in class ComposedType

Parameters:

ctx - the current session context which this item is created within

type - the actual item type ( since subtypes may not provide a own jalo class this may be different from the type which this method was implemented for )

Returns:

the new item instance

Throws:

JaloBusinessException - indicates an error during creation - any changes will be rollbacked

getJaloClass

public Class getJaloClass()

Redefined to return ViewResultItem class.

Overrides:

getJaloClass in class ComposedType

Returns:

the jalo class object of the item defined by this type. if this type doesnt have a own jalo class the supertype is used.

isAbstract

public boolean isAbstract()

redefined to return true always.

Overrides:

isAbstract in class ComposedType

Returns:

true if the type cannot have instances.

toString

public String toString(SessionContext ctx,
                       Object value)
                throws JaloInvalidParameterException

Overrides:

toString in class ComposedType

Throws:

JaloInvalidParameterException

Since:

2.10

parseValue

public Object parseValue(SessionContext ctx,
                         String value)
                  throws JaloInvalidParameterException

Overrides:

parseValue in class ComposedType

Throws:

JaloInvalidParameterException

Since:

2.10

getQuery

public String getQuery()

Returns:

the flexible search query which defines the instances of this view type

setQuery

public void setQuery(String q)

Changes the flexible search query of this view type.

Please make sure that the amount and oder of the column and param attribute descriptors of this type still match the query!

Parameters:

q - the new query - must not be null

setParamAttributeDescriptors

protected void setParamAttributeDescriptors(Set params)

Changes the current param attribute descriptor set. All previous attribute descriptors which are not contained in the new set are removed.

Parameters:

params - the new set of param attribute descriptors

getParamAttributeDescriptors

public Set getParamAttributeDescriptors()

Returns:

a set of all attribute descriptors which describe query params for this view type

setColumnAttributeDescriptors

protected void setColumnAttributeDescriptors(List cols)

Changes the current column attribute descriptor list. All previous attribute descriptors which are not contained in the new set are removed. The list order must match the query SELECT order!

Parameters:

cols - the new list of column attribute descriptors

getColumnAttributeDescriptors

public List getColumnAttributeDescriptors()

Returns:

a set of all attribute descriptors which describe query params for this view type

getResultRowSignature

protected List getResultRowSignature(List resultRowAttributes)

createAttributeMapFromRow

protected Map createAttributeMapFromRow(List resultAttributes,
                                        List rowData)

convertGenericValueConditions

public Map convertGenericValueConditions(GenericCondition cond)

Since:

2.10

search

public SearchResult search(Map values,
                           boolean dontNeedTotal,
                           int start,
                           int count)

search

public SearchResult search(SessionContext ctx,
                           Map values,
                           boolean dontNeedTotal,
                           int start,
                           int count)

getXMLCustomProperties

protected Map getXMLCustomProperties(String forExtension)

Exports its query as XML custom properties.

Overrides:

getXMLCustomProperties in class ComposedType