Package de.hybris.platform.jalo.type
Class ViewType
- java.lang.Object
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.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 Description static java.lang.String
COLUMNS
static java.lang.String
PARAMS
static java.lang.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, HJMPTS, 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 Description ViewType()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Map
convertGenericValueConditions(GenericCondition cond)
protected java.util.Map
createAttributeMapFromRow(java.util.List resultAttributes, java.util.List rowData)
protected Item
createItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes)
The generic creator method for creating new composed types byComposedType.newInstance(Map)
.java.util.List
getColumnAttributeDescriptors()
java.lang.Class
getJaloClass()
Redefined to returnViewResultItem
class.java.util.Set
getParamAttributeDescriptors()
java.lang.String
getQuery()
protected java.util.List
getResultRowSignature(java.util.List resultRowAttributes)
protected java.util.Map
getXMLCustomProperties(java.lang.String forExtension)
Exports its query as XML custom properties.boolean
isAbstract()
redefined to returntrue
always.java.lang.Object
parseValue(SessionContext ctx, java.lang.String value)
SearchResult
search(SessionContext ctx, java.util.Map values, boolean dontNeedTotal, int start, int count)
SearchResult
search(java.util.Map values, boolean dontNeedTotal, int start, int count)
protected void
setColumnAttributeDescriptors(java.util.List cols)
Changes the current column attribute descriptor list.protected void
setParamAttributeDescriptors(java.util.Set params)
Changes the current param attribute descriptor set.void
setQuery(java.lang.String q)
Changes the flexible search query of this view type.java.lang.String
toString(SessionContext ctx, java.lang.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, hasOwnDeployment, 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, getImplementation, 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, getRelatedItems, getRestrictedPrincipals, getSession, getSyncObject, getTenant, getTransientObject, getTransientObjectMap, hashCode, hasRegisteredClassAccessorFor, internal_registerClassAccessorFor, internal_registerNonClassAccessorFor, invalidateLocalCaches, isAlive, isCacheBound, isCurrentlyRemoving, isCurrentlyRemoving, isEmptyRelationValue, isInCreate, isInstanceOf, isItemCheckBeforeRemoveableDisabled, isMarkModifiedDisabled, isRelationLocalizationFallbackEnabled, newInstance, notifyExtensionsAfterItemCreation, notifyExtensionsBeforeItemCreation, notifyItemRemoval, notifyManagerAboutItemRemoval, readResolve, 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, setRelatedItems, setTransientObject, setUseTA, useTA, writeReplace
-
Methods inherited from class de.hybris.platform.util.BridgeAbstraction
setTenant
-
-
-
-
Field Detail
-
QUERY
public static final java.lang.String QUERY
- See Also:
- Constant Field Values
-
COLUMNS
public static final java.lang.String COLUMNS
- See Also:
- Constant Field Values
-
PARAMS
public static final java.lang.String PARAMS
- See Also:
- Constant Field Values
-
-
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 byComposedType.newInstance(Map)
.Required attributes are:
- Overrides:
createItem
in classComposedType
- Parameters:
ctx
- the current session context which this item is created withintype
- 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 java.lang.Class getJaloClass()
Redefined to returnViewResultItem
class.- Overrides:
getJaloClass
in classComposedType
- 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 returntrue
always.- Overrides:
isAbstract
in classComposedType
- Returns:
- true if the type cannot have instances.
-
toString
public java.lang.String toString(SessionContext ctx, java.lang.Object value) throws JaloInvalidParameterException
- Overrides:
toString
in classComposedType
- Throws:
JaloInvalidParameterException
- Since:
- 2.10
-
parseValue
public java.lang.Object parseValue(SessionContext ctx, java.lang.String value) throws JaloInvalidParameterException
- Overrides:
parseValue
in classComposedType
- Throws:
JaloInvalidParameterException
- Since:
- 2.10
-
getQuery
public java.lang.String getQuery()
- Returns:
- the flexible search query which defines the instances of this view type
-
setQuery
public void setQuery(java.lang.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(java.util.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 java.util.Set getParamAttributeDescriptors()
- Returns:
- a set of all attribute descriptors which describe query params for this view type
-
setColumnAttributeDescriptors
protected void setColumnAttributeDescriptors(java.util.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 java.util.List getColumnAttributeDescriptors()
- Returns:
- a set of all attribute descriptors which describe query params for this view type
-
getResultRowSignature
protected java.util.List getResultRowSignature(java.util.List resultRowAttributes)
-
createAttributeMapFromRow
protected java.util.Map createAttributeMapFromRow(java.util.List resultAttributes, java.util.List rowData)
-
convertGenericValueConditions
public java.util.Map convertGenericValueConditions(GenericCondition cond)
- Since:
- 2.10
-
search
public SearchResult search(java.util.Map values, boolean dontNeedTotal, int start, int count)
-
search
public SearchResult search(SessionContext ctx, java.util.Map values, boolean dontNeedTotal, int start, int count)
-
getXMLCustomProperties
protected java.util.Map getXMLCustomProperties(java.lang.String forExtension)
Exports its query as XML custom properties.- Overrides:
getXMLCustomProperties
in classComposedType
-
-