HMCHelper (hybris Commerce Suite 6.3.0.0-SNAPSHOT)

java.lang.Object
- de.hybris.platform.hmc.HMCHelper

```
public class HMCHelper
extends Object
```
This is a helper class with helper functions :).

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`HMCHelper.AttributePreset`
`static class`	`HMCHelper.DefaultHMCContext` Default `HMCContext` implementation.
`static class`	`HMCHelper.XSSFilter` Filtering utility for protecting against XSS (Cross Site Scripting).

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DATE_PATTERN`
`static String`	`DEFAULT_DATE_PATTERN`
`static String`	`DEFAULT_TIME_PATTERN`
`static String`	`HMC_DEVELOPERMODE` Deprecated. use `ConfigConstants.DEVELOPERMODE` directly
`static String`	`HMC_NAMESPACE`
`static String`	`LOG_DIVIDER`
`static String`	`MONTH_APR`
`static String`	`MONTH_AUG`
`static String`	`MONTH_DEC`
`static String`	`MONTH_FEB`
`static String`	`MONTH_JAN`
`static String`	`MONTH_JUL`
`static String`	`MONTH_JUN`
`static String`	`MONTH_MAR`
`static String`	`MONTH_MAY`
`static String`	`MONTH_NOV`
`static String`	`MONTH_OCT`
`static String`	`MONTH_SEP`
`static String`	`NONE`
`static String`	`SCHEMA_URL_PROPERTY`
`static String`	`SESSION_STRUCTURE_TIMESTAMP`
`static String`	`TIME_PATTERN`
`static String`	`USE_DB_STRUCTURE` Deprecated. use `ConfigConstants.STRUCTURE_DB` directly
`static String`	`WEEKDAY_FR`
`static String`	`WEEKDAY_MO`
`static String`	`WEEKDAY_SA`
`static String`	`WEEKDAY_SU`
`static String`	`WEEKDAY_TH`
`static String`	`WEEKDAY_TU`
`static String`	`WEEKDAY_WE`

Constructor Summary

Constructors
Modifier Constructor and Description

protected HMCHelper()

Constructors
Modifier	Constructor and Description
`protected`	`HMCHelper()`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static void`	`clearThreadLocals()`
`static boolean`	`collectionsEqual(Collection col1, Collection col2, boolean ignoreSequence)` Returns true if the two given collections are equal.
`static boolean`	`containsIgnoreCase(Collection stringColl, String qualifier)`
`static String`	`detab(String text, int spaceCount)` Replace tabs within the given string with equivalent spaces.
`static boolean`	`extractBooleanAttribute(Map<String,String> attributes, String attributeName, boolean defaultValue)`
`static int`	`extractIntegerAttribute(Map<String,String> attributes, String attributeName, int defaultValue)`
`static String`	`extractStringAttribute(Map<String,String> attributes, String attributeName, String defaultValue)`
`static SavedQuery`	`findSavedQuery(ComposedType type, String code)` Finds and returns a SavedQuery which result type is of the given type (or one of its supertypes) and which code is equal to the given code.
`static String`	`getAttributeDescriptorName(AttributeDescriptor descriptor)`
`static String`	`getAttributeDescriptorName(DisplayState displayState, AttributeDescriptor attributeDescriptor)`
`static String`	`getClassName(Class theClass)`
`static Object`	`getClipboard()` Returns the value currently contained in the clipboard.
`static ComposedType`	`getComposedTypeType()`
`static ComposedType`	`getComposedTypeType(JaloSession jaloSession)` Deprecated. Use `getComposedTypeType()` instead.
`static String`	`getCoreExceptionMessage(DisplayState displayState, Exception exception)`
`static ComposedType`	`getCountryType()`
`static ComposedType`	`getCountryType(JaloSession jaloSession)` Deprecated. Use `getCountryType()` instead.
`static ComposedType`	`getCurrencyType()`
`static ComposedType`	`getCurrencyType(JaloSession jaloSession)` Deprecated. Use `getCurrencyType()` instead.
`static ComposedType`	`getCustomerType()`
`static ComposedType`	`getCustomerType(JaloSession jaloSession)` Deprecated. Use `getCustomerType()` instead.
`static DateFormat`	`getDateFormat(String pattern)` Gets a DateFormat instance for the given date pattern string.
`static String`	`getDefaultDatePattern()` Returns the default date pattern for the current locale (from the appropriate locales.properties file).
`static String`	`getDefaultTimePattern()` Returns the default time pattern for the current locale (from the appropriate locales.properties file).
`static Map`	`getDefaultValues(ComposedType composedType)`
`static ComposedType`	`getDeliveryModeType()`
`static ComposedType`	`getDeliveryModeType(JaloSession jaloSession)` Deprecated. Use `getDeliveryModeType()` instead.
`static ComposedType`	`getDiscountType()`
`static ComposedType`	`getDiscountType(JaloSession jaloSession)` Deprecated. Use `getDiscountType()` instead.
`static ComposedType`	`getEmployeeType()`
`static ComposedType`	`getEmployeeType(JaloSession jaloSession)` Deprecated. Use `getEmployeeType()` instead.
`static ComposedType`	`getEnumerationValueType()`
`static ComposedType`	`getEnumerationValueType(JaloSession jaloSession)` Deprecated. Use `getEnumerationValueType()` instead.
`static HMCContext`	`getHMCContextFor(AbstractChip chip)`
`static ComposedType`	`getItemType()`
`static ComposedType`	`getLanguageType()`
`static ComposedType`	`getLanguageType(JaloSession jaloSession)` Deprecated. Use `getLanguageType()` instead.
`static Locale`	`getLocale(Language language)`
`static String`	`getLocalizedMonths()` Returns a javascript string array as a string which contains all twelve months as their localized abbreviations.
`static String`	`getLocalizedString(String strKey)` Returns a localized string for the given key or the key itself if no localized string were found.
`static String`	`getLocalizedWeekdays()` Returns a javascript string array as a string which contains all seven weekdays as their localized abbreviations.
`static ComposedType`	`getMediaType()`
`static ComposedType`	`getMediaType(JaloSession jaloSession)` Deprecated. Use `getMediaType()` instead.
`static NumberFormat`	`getNumberFormat(String numberPattern, Locale locale)` Returns the NumberFormat for the current locale and the given pattern string.
`static ComposedType`	`getOrderType()`
`static ComposedType`	`getOrderType(JaloSession jaloSession)` Deprecated. Use `getOrderType()` instead.
`static NumberFormat`	`getPriceFormat(JaloSession jaloSession)` method returns a price format according to currently selected language
`static ComposedType`	`getPrincipalType()`
`static ComposedType`	`getPrincipalType(JaloSession jaloSession)` Deprecated. Use `getPrincipalType()` instead.
`static ComposedType`	`getProductType()`
`static ComposedType`	`getProductType(JaloSession jaloSession)` Deprecated. Use `getProductType()` instead.
`static List<SavedQuery>`	`getSavedQueries(ComposedType type)` For the given `ComposedType` all available `SavedQueries` (with this type as return type) are returned.
`static Item`	`getSingleClipboardItem()` Returns an Item contained in the clipboard.
`static Item`	`getSingleClipboardItem(ComposedType type)` Returns an Item contained in the clipboard which is an instance of the specified ComposedType.
`static ComposedType`	`getTaxType()`
`static ComposedType`	`getTaxType(JaloSession jaloSession)` Deprecated. Use `getTaxType()` instead.
`static ComposedType`	`getTitleType()`
`static ComposedType`	`getTitleType(JaloSession jaloSession)` Deprecated. Use `getTitleType()` instead.
`static ComposedType`	`getType(Class jaloClass)`
`static ComposedType`	`getType(JaloSession jaloSession, Class jaloClass)` Deprecated. Use `getType(Class)` instead.
`static String`	`getTypeName(DisplayState displayState, Type type)` Deprecated. please use `getTypeName(Type)` instead, the displaystate is not necessary
`static String`	`getTypeName(Type type)` This helper functions returns the localized name of the given type.
`static ComposedType`	`getTypeType()`
`static ComposedType`	`getTypeType(JaloSession jaloSession)` Deprecated. Use `getTypeType()` instead.
`static ComposedType`	`getUnitType()`
`static ComposedType`	`getUnitType(JaloSession jaloSession)` Deprecated. Use `getUnitType()` instead.
`static ComposedType`	`getUserGroupType()`
`static ComposedType`	`getUserGroupType(JaloSession jaloSession)` Deprecated. Use `getUserGroupType()` instead.
`static Map<String,Object>`	`getValueMap(GenericItemChip itemChip, ComposedType type, Collection<HMCHelper.AttributePreset> presets)`
`static Collection`	`getVariantAttributeDescriptors(ComposedType type)` For the given ComposedType all VariantAttributeDescriptors (if any) are returned.
`static HMCHelper.XSSFilter`	`getXSSFilter()`
`static HMCHelper.XSSFilter`	`getXSSFilter(String tag)` Returns an XSSFilter instance for which the submitted tag was removed from the internal the predefined "alowwed entitties" list Note: In some cases (see PLA-8216) we want to exclude some html tags from the mentioned list
`static boolean`	`isContainedInMainWindow(AbstractChip chip)` Returns true if the given chip is contained in the main window.
`static boolean`	`isImage(Media media)` Returns true if the given media object contains an url that points to an image file.
`static boolean`	`isInMainWindow(AbstractChip chip)`
`static boolean`	`isMainChip(Chip theChip)`
`static boolean`	`isUrlReachable(String urlString)` Returns true if the schema url (configuration property 'hmc.schema.url') is correct, reachable and does not have an empty content.
`static void`	`LogHeader(Class source, Priority prio, String header)`
`static void`	`LogHeader(Class source, String header)`
`static String`	`makeString(Language language)`
`static void`	`openItemCreator(Collection elementTypes, Map initialValues, AttributeChip openingAttributeChip, GenericItemChip openingItemChip, AbstractAttributeEditorChip openingEditorChip)`
`static void`	`openItemCreator(ComposedType itemType, Map initialValues, AttributeChip openingAttributeChip, ItemChip openingItemChip, AbstractAttributeEditorChip openingEditorChip, boolean considerSubtypes)` Opens a new window to create a new item.
`static void`	`openItemCreator(ComposedType itemType, Map initialValues, AttributeChip openingAttributeChip, ItemChip openingItemChip, AbstractAttributeEditorChip openingEditorChip, boolean considerSubtypes, boolean isModal)` Opens a new window to create a new item.
`static void`	`openItemCreatorInOrganizer(ComposedType type)` For the given composedtype a creator will be opened within the organizer.
`static void`	`openItemSearch(ComposedType typeToSearch, ItemAcceptor itemAcceptor, ReferenceEditorNode referenceEditorNode, boolean autoPerform, Map presetValues)` Opens a new window containing an item search.
`static void`	`openItemSearch(ComposedType typeToSearch, ItemAcceptor itemAcceptor, ReferenceEditorNode referenceEditorNode, boolean autoPerform, Map presetValues, ComposedType presetSearchType)` Opens a new window containing an item search.
`static String`	`removeSpaces(String value)`
`static String`	`replace(String str, String pattern, String replace)` Replaces a given pattern "pattern" in a String "str" with the pattern "replace".
`static String`	`reTranslate(String value)`
`static double`	`round(double number, int digits)` Rounds a given double to the given fraction digits.
`static float`	`round(float number, int digits)` Rounds a given float to the given fraction digits.
`static int`	`searchItems(String argument, Collection<Item> results, ComposedType searchType, Collection<String> searchAttributes, Map<String,Object> presetValues, Operator condition, int range, boolean includeSubTypes)` Searches items based on the given search argument.
`static int`	`searchItems(String argument, Collection<Item> results, ComposedType searchType, Collection<String> searchAttributes, Operator condition, int range, boolean includeSubTypes)` Searches items based on the given search argument.
`static void`	`setPresetConditions(GenericSearchChip searchChip, Map presetValues)`
`static void`	`swallowException(Exception exception)`
`static String`	`translate(String key)`
`static String`	`xssEncodeHTML(String s)` Thin wrapper method around `XSSEncoder#encodeHTML(String)` to avoid catching exceptions all over the place!
`static String`	`xssEncodeHTMLPreservingIndentation(String str)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LOG_DIVIDER
```
public static final String LOG_DIVIDER
```
    See Also:
    
    Constant Field Values
  - NONE
```
public static final String NONE
```
    See Also:
    
    Constant Field Values
  - USE_DB_STRUCTURE
```
@Deprecated
public static final String USE_DB_STRUCTURE
```
    Deprecated. use ConfigConstants.STRUCTURE_DB directly
    
    See Also:
    
    Constant Field Values
  - SESSION_STRUCTURE_TIMESTAMP
```
public static final String SESSION_STRUCTURE_TIMESTAMP
```
    See Also:
    
    Constant Field Values
  - HMC_DEVELOPERMODE
```
@Deprecated
public static final String HMC_DEVELOPERMODE
```
    Deprecated. use ConfigConstants.DEVELOPERMODE directly
    
    See Also:
    
    Constant Field Values
  - HMC_NAMESPACE
```
public static final String HMC_NAMESPACE
```
    See Also:
    
    Constant Field Values
  - SCHEMA_URL_PROPERTY
```
public static final String SCHEMA_URL_PROPERTY
```
    See Also:
    
    Constant Field Values
  - DEFAULT_DATE_PATTERN
```
public static final String DEFAULT_DATE_PATTERN
```
    Since:
    
    2.20 (was private before)
    
    See Also:
    
    Constant Field Values
  - DATE_PATTERN
```
public static final String DATE_PATTERN
```
    Since:
    
    2.20 (was private before)
    
    See Also:
    
    Constant Field Values
  - DEFAULT_TIME_PATTERN
```
public static final String DEFAULT_TIME_PATTERN
```
    Since:
    
    2.20 (was private before)
    
    See Also:
    
    Constant Field Values
  - TIME_PATTERN
```
public static final String TIME_PATTERN
```
    Since:
    
    2.20 (was private before)
    
    See Also:
    
    Constant Field Values
  - MONTH_JAN
```
public static final String MONTH_JAN
```
    Since:
    
    2.20
    
    See Also:
    
    Constant Field Values
  - MONTH_FEB
```
public static final String MONTH_FEB
```
    Since:
    
    2.20
    
    See Also:
    
    Constant Field Values
  - MONTH_MAR
```
public static final String MONTH_MAR
```
    Since:
    
    2.20
    
    See Also:
    
    Constant Field Values
  - MONTH_APR
```
public static final String MONTH_APR
```
    Since:
    
    2.20
    
    See Also:
    
    Constant Field Values
  - MONTH_MAY
```
public static final String MONTH_MAY
```
    Since:
    
    2.20
    
    See Also:
    
    Constant Field Values
  - MONTH_JUN
```
public static final String MONTH_JUN
```
    Since:
    
    2.20
    
    See Also:
    
    Constant Field Values
  - MONTH_JUL
```
public static final String MONTH_JUL
```
    Since:
    
    2.20
    
    See Also:
    
    Constant Field Values
  - MONTH_AUG
```
public static final String MONTH_AUG
```
    Since:
    
    2.20
    
    See Also:
    
    Constant Field Values
  - MONTH_SEP
```
public static final String MONTH_SEP
```
    Since:
    
    2.20
    
    See Also:
    
    Constant Field Values
  - MONTH_OCT
```
public static final String MONTH_OCT
```
    Since:
    
    2.20
    
    See Also:
    
    Constant Field Values
  - MONTH_NOV
```
public static final String MONTH_NOV
```
    Since:
    
    2.20
    
    See Also:
    
    Constant Field Values
  - MONTH_DEC
```
public static final String MONTH_DEC
```
    Since:
    
    2.20
    
    See Also:
    
    Constant Field Values
  - WEEKDAY_MO
```
public static final String WEEKDAY_MO
```
    Since:
    
    2.20
    
    See Also:
    
    Constant Field Values
  - WEEKDAY_TU
```
public static final String WEEKDAY_TU
```
    Since:
    
    2.20
    
    See Also:
    
    Constant Field Values
  - WEEKDAY_WE
```
public static final String WEEKDAY_WE
```
    Since:
    
    2.20
    
    See Also:
    
    Constant Field Values
  - WEEKDAY_TH
```
public static final String WEEKDAY_TH
```
    Since:
    
    2.20
    
    See Also:
    
    Constant Field Values
  - WEEKDAY_FR
```
public static final String WEEKDAY_FR
```
    Since:
    
    2.20
    
    See Also:
    
    Constant Field Values
  - WEEKDAY_SA
```
public static final String WEEKDAY_SA
```
    Since:
    
    2.20
    
    See Also:
    
    Constant Field Values
  - WEEKDAY_SU
```
public static final String WEEKDAY_SU
```
    Since:
    
    2.20
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - HMCHelper
```
protected HMCHelper()
```
- Method Detail
  - clearThreadLocals
```
public static void clearThreadLocals()
```
  - getHMCContextFor
```
public static HMCContext getHMCContextFor(AbstractChip chip)
```
  - getXSSFilter
```
public static HMCHelper.XSSFilter getXSSFilter()
```
  - getXSSFilter
```
public static HMCHelper.XSSFilter getXSSFilter(String tag)
```
    Returns an XSSFilter instance for which the submitted tag was removed from the internal the predefined "alowwed entitties" list Note: In some cases (see PLA-8216) we want to exclude some html tags from the mentioned list
    
    Parameters:
    
    tag - html tag which will be excluded
    
    Returns:
    
    XSS Filter instance
  - LogHeader
```
public static void LogHeader(Class source,
                             String header)
```
  - LogHeader
```
public static void LogHeader(Class source,
                             Priority prio,
                             String header)
```
  - getPriceFormat
```
public static NumberFormat getPriceFormat(JaloSession jaloSession)
```
    method returns a price format according to currently selected language
    
    Parameters:
    
    jaloSession -
    
    Returns:
    
    NumberFormat for prices wit two fraction digits
  - makeString
```
public static final String makeString(Language language)
```
  - getLocale
```
public static final Locale getLocale(Language language)
```
  - getType
```
public static ComposedType getType(Class jaloClass)
```
    Since:
    
    2.20
  - getType
```
@Deprecated
public static ComposedType getType(JaloSession jaloSession,
                                               Class jaloClass)
```
    Deprecated. Use getType(Class) instead.
    
    Since:
    
    2.20 (deprecated)
  - getCustomerType
```
public static ComposedType getCustomerType()
```
    Since:
    
    2.20
  - getCustomerType
```
@Deprecated
public static ComposedType getCustomerType(JaloSession jaloSession)
```
    Deprecated. Use getCustomerType() instead.
    
    Since:
    
    2.20 (deprecated)
  - getUserGroupType
```
public static ComposedType getUserGroupType()
```
    Since:
    
    2.20
  - getUserGroupType
```
@Deprecated
public static ComposedType getUserGroupType(JaloSession jaloSession)
```
    Deprecated. Use getUserGroupType() instead.
    
    Since:
    
    2.20 (deprecated)
  - getProductType
```
public static ComposedType getProductType()
```
    Since:
    
    2.20
  - getProductType
```
@Deprecated
public static ComposedType getProductType(JaloSession jaloSession)
```
    Deprecated. Use getProductType() instead.
    
    Since:
    
    2.20 (deprecated)
  - getComposedTypeType
```
public static ComposedType getComposedTypeType()
```
    Since:
    
    2.20
  - getComposedTypeType
```
@Deprecated
public static ComposedType getComposedTypeType(JaloSession jaloSession)
```
    Deprecated. Use getComposedTypeType() instead.
    
    Since:
    
    2.20 (deprecated)
  - getEnumerationValueType
```
public static ComposedType getEnumerationValueType()
```
    Since:
    
    2.20
  - getEnumerationValueType
```
@Deprecated
public static ComposedType getEnumerationValueType(JaloSession jaloSession)
```
    Deprecated. Use getEnumerationValueType() instead.
    
    Since:
    
    2.20 (deprecated)
  - getEmployeeType
```
public static ComposedType getEmployeeType()
```
    Since:
    
    2.20
  - getEmployeeType
```
@Deprecated
public static ComposedType getEmployeeType(JaloSession jaloSession)
```
    Deprecated. Use getEmployeeType() instead.
    
    Since:
    
    2.20 (deprecated)
  - getPrincipalType
```
public static ComposedType getPrincipalType()
```
    Since:
    
    2.20
  - getPrincipalType
```
@Deprecated
public static ComposedType getPrincipalType(JaloSession jaloSession)
```
    Deprecated. Use getPrincipalType() instead.
    
    Since:
    
    2.20 (deprecated)
  - getTitleType
```
public static ComposedType getTitleType()
```
    Since:
    
    2.20
  - getTitleType
```
@Deprecated
public static ComposedType getTitleType(JaloSession jaloSession)
```
    Deprecated. Use getTitleType() instead.
    
    Since:
    
    2.20 (deprecated)
  - getCountryType
```
public static ComposedType getCountryType()
```
    Since:
    
    2.20
  - getCountryType
```
@Deprecated
public static ComposedType getCountryType(JaloSession jaloSession)
```
    Deprecated. Use getCountryType() instead.
    
    Since:
    
    2.20 (deprecated)
  - getCurrencyType
```
public static ComposedType getCurrencyType()
```
    Since:
    
    2.20
  - getCurrencyType
```
@Deprecated
public static ComposedType getCurrencyType(JaloSession jaloSession)
```
    Deprecated. Use getCurrencyType() instead.
    
    Since:
    
    2.20 (deprecated)
  - getLanguageType
```
public static ComposedType getLanguageType()
```
    Since:
    
    2.20
  - getLanguageType
```
@Deprecated
public static ComposedType getLanguageType(JaloSession jaloSession)
```
    Deprecated. Use getLanguageType() instead.
    
    Since:
    
    2.20 (deprecated)
  - getMediaType
```
public static ComposedType getMediaType()
```
    Since:
    
    2.20
  - getMediaType
```
@Deprecated
public static ComposedType getMediaType(JaloSession jaloSession)
```
    Deprecated. Use getMediaType() instead.
    
    Since:
    
    2.20 (deprecated)
  - getUnitType
```
public static ComposedType getUnitType()
```
    Since:
    
    2.20
  - getUnitType
```
@Deprecated
public static ComposedType getUnitType(JaloSession jaloSession)
```
    Deprecated. Use getUnitType() instead.
    
    Since:
    
    2.20 (deprecated)
  - getTaxType
```
public static ComposedType getTaxType()
```
    Since:
    
    2.20
  - getTaxType
```
@Deprecated
public static ComposedType getTaxType(JaloSession jaloSession)
```
    Deprecated. Use getTaxType() instead.
    
    Since:
    
    2.20 (deprecated)
  - getDiscountType
```
public static ComposedType getDiscountType()
```
    Since:
    
    2.20
  - getDiscountType
```
@Deprecated
public static ComposedType getDiscountType(JaloSession jaloSession)
```
    Deprecated. Use getDiscountType() instead.
    
    Since:
    
    2.20 (deprecated)
  - getDeliveryModeType
```
public static ComposedType getDeliveryModeType()
```
    Since:
    
    2.20
  - getDeliveryModeType
```
@Deprecated
public static ComposedType getDeliveryModeType(JaloSession jaloSession)
```
    Deprecated. Use getDeliveryModeType() instead.
    
    Since:
    
    2.20 (deprecated)
  - getOrderType
```
public static ComposedType getOrderType()
```
    Since:
    
    2.20
  - getOrderType
```
@Deprecated
public static ComposedType getOrderType(JaloSession jaloSession)
```
    Deprecated. Use getOrderType() instead.
    
    Since:
    
    2.20 (deprecated)
  - getTypeType
```
public static ComposedType getTypeType()
```
    Since:
    
    2.20
  - getTypeType
```
@Deprecated
public static ComposedType getTypeType(JaloSession jaloSession)
```
    Deprecated. Use getTypeType() instead.
    
    Since:
    
    2.20 (deprecated)
  - getItemType
```
public static ComposedType getItemType()
```
    Since:
    
    2.20
  - translate
```
public static String translate(String key)
```
  - reTranslate
```
public static String reTranslate(String value)
```
  - getTypeName
```
@Deprecated
public static String getTypeName(DisplayState displayState,
                                             Type type)
```
    Deprecated. please use getTypeName(Type) instead, the displaystate is not necessary
    
    This helper functions returns the localized name of the given type. If the localized name for the type is set, it will be returned, otherwise the code is returned in brackets.
    
    Parameters:
    
    displayState - the displaystate
    
    type - the type
    
    Returns:
    
    the typename
  - getTypeName
```
public static String getTypeName(Type type)
```
    This helper functions returns the localized name of the given type. If the localized name for the type is set, it will be returned, otherwise the code is returned in brackets.
    
    Parameters:
    
    type - the type
    
    Returns:
    
    the typename
  - getAttributeDescriptorName
```
public static String getAttributeDescriptorName(DisplayState displayState,
                                                AttributeDescriptor attributeDescriptor)
```
  - getAttributeDescriptorName
```
public static String getAttributeDescriptorName(AttributeDescriptor descriptor)
```
    Parameters:
    
    descriptor - the attribute descriptor
    
    Since:
    
    3.00 (beta1)
  - removeSpaces
```
public static String removeSpaces(String value)
```
  - swallowException
```
public static void swallowException(Exception exception)
```
  - isMainChip
```
public static boolean isMainChip(Chip theChip)
```
  - replace
```
public static String replace(String str,
                             String pattern,
                             String replace)
```
    Replaces a given pattern "pattern" in a String "str" with the pattern "replace". If the String "str" is null an empty String is returned.
  - getCoreExceptionMessage
```
public static String getCoreExceptionMessage(DisplayState displayState,
                                             Exception exception)
```
  - isUrlReachable
```
public static boolean isUrlReachable(String urlString)
```
    Returns true if the schema url (configuration property 'hmc.schema.url') is correct, reachable and does not have an empty content.
    
    Returns:
    
    true if the schema url is okay
  - detab
```
public static String detab(String text,
                           int spaceCount)
```
    Replace tabs within the given string with equivalent spaces.
    
    Parameters:
    
    text - the string which is to be detabbed
    
    spaceCount - the number of spaces which will replace tabs
    
    Returns:
    
    detabbed string
  - getLocalizedString
```
public static String getLocalizedString(String strKey)
```
    Returns a localized string for the given key or the key itself if no localized string were found.
    Calls getLocalizedString on the current DisplayState.
    
    Parameters:
    
    strKey - the key to get a localized representation for.
    
    Returns:
    
    a localized string for the given key or the key enclosed in [] key -> [key].
  - containsIgnoreCase
```
public static boolean containsIgnoreCase(Collection stringColl,
                                         String qualifier)
```
    Returns:
    
    true if the given qualifier is contained in the given collection while ignoring upper and lower case.
  - getClassName
```
public static String getClassName(Class theClass)
```
    Parameters:
    
    theClass -
    
    Returns:
    
    the classname of the given class without packages.
  - round
```
public static double round(double number,
                           int digits)
```
    Rounds a given double to the given fraction digits.
  - round
```
public static float round(float number,
                          int digits)
```
    Rounds a given float to the given fraction digits.
  - isImage
```
public static final boolean isImage(Media media)
```
    Returns true if the given media object contains an url that points to an image file. The decision is based on mimetype or - if the mimetype is missing - on the filename's suffix.
    
    Parameters:
    
    media - the media object in question
    
    Returns:
    
    true if the given media object describes an image file
  - collectionsEqual
```
public static boolean collectionsEqual(Collection col1,
                                       Collection col2,
                                       boolean ignoreSequence)
```
    Returns true if the two given collections are equal. I.e. if both are null, both are empty or if both contain the same elements (ignoring the sequence of the elements or not, depending on the ignoreSequence parameter).
    
    Parameters:
    
    col1 - first collection, may be null
    
    col2 - second collection, may be null
    
    ignoreSequence - if true, the order in which the elements appear within the two collections will be ignored
    
    Returns:
    
    true if the two given collections are equal
    
    Since:
    
    2.00
  - getDateFormat
```
public static final DateFormat getDateFormat(String pattern)
```
    Gets a DateFormat instance for the given date pattern string.
    
    Parameters:
    
    pattern - a date pattern, e.g. 'dd.MM.yyyy'
    
    Returns:
    
    a DateFormat instance for the given date pattern string.
  - getDefaultDatePattern
```
public static final String getDefaultDatePattern()
```
    Returns the default date pattern for the current locale (from the appropriate locales.properties file).
    
    Returns:
    
    the default date pattern for the current locale
  - getDefaultTimePattern
```
public static final String getDefaultTimePattern()
```
    Returns the default time pattern for the current locale (from the appropriate locales.properties file).
    
    Returns:
    
    the default time pattern for the current locale
  - getLocalizedMonths
```
public static final String getLocalizedMonths()
```
    Returns a javascript string array as a string which contains all twelve months as their localized abbreviations.
    
    Returns:
    
    a javascript string array as a string which contains all twelve months as their localized abbreviations.
    
    Since:
    
    2.20
  - getLocalizedWeekdays
```
public static final String getLocalizedWeekdays()
```
    Returns a javascript string array as a string which contains all seven weekdays as their localized abbreviations.
    
    Returns:
    
    a javascript string array as a string which contains all seven weekdays as their localized abbreviations.
    
    Since:
    
    2.20
  - getNumberFormat
```
public static final NumberFormat getNumberFormat(String numberPattern,
                                                 Locale locale)
```
    Returns the NumberFormat for the current locale and the given pattern string.
    
    Returns:
    
    the NumberFormat for the current locale and the given pattern string.
  - openItemCreator
```
public static void openItemCreator(ComposedType itemType,
                                   Map initialValues,
                                   AttributeChip openingAttributeChip,
                                   ItemChip openingItemChip,
                                   AbstractAttributeEditorChip openingEditorChip,
                                   boolean considerSubtypes)
```
    Opens a new window to create a new item.
    
    Parameters:
    
    itemType - the ComposedType of the new item
    
    initialValues - a map containing initial values (may be empty) where attribute qualifiers must be mapped to values
    
    openingAttributeChip - the AttributeChip from which the create window was opened (may be null), is used to update the opening chip
    
    openingItemChip - the ItemChip from which the create window was opened (may be null), is used to update the opening chip
    
    openingEditorChip - the AbstractAttributeEditorChip from which the create window was opened (may be null), , is used to update the opening chip
    
    considerSubtypes - if true a dialog to select a concrete subtype (if any) will appear before the actual create window
  - openItemCreator
```
public static void openItemCreator(Collection elementTypes,
                                   Map initialValues,
                                   AttributeChip openingAttributeChip,
                                   GenericItemChip openingItemChip,
                                   AbstractAttributeEditorChip openingEditorChip)
```
    Parameters:
    
    elementTypes -
    
    initialValues -
    
    openingAttributeChip -
    
    openingItemChip -
    
    openingEditorChip -
    
    Since:
    
    2.20
  - openItemCreator
```
public static void openItemCreator(ComposedType itemType,
                                   Map initialValues,
                                   AttributeChip openingAttributeChip,
                                   ItemChip openingItemChip,
                                   AbstractAttributeEditorChip openingEditorChip,
                                   boolean considerSubtypes,
                                   boolean isModal)
```
    Opens a new window to create a new item.
    
    Parameters:
    
    itemType - the ComposedType of the new item
    
    initialValues - a map containing initial values (may be empty) where attribute qualifiers must be mapped to values
    
    openingAttributeChip - the AttributeChip from which the create window was opened (may be null), is used to update the opening chip
    
    openingItemChip - the ItemChip from which the create window was opened (may be null), is used to update the opening chip
    
    openingEditorChip - the AbstractAttributeEditorChip from which the create window was opened (may be null), , is used to update the opening chip
    
    considerSubtypes - if true a dialog to select a concrete subtype (if any) will appear before the actual create window
    
    isModal - if true the new window will be in modal mode
  - isInMainWindow
```
public static boolean isInMainWindow(AbstractChip chip)
```
    Since:
    
    2.30
  - openItemCreatorInOrganizer
```
public static void openItemCreatorInOrganizer(ComposedType type)
```
    For the given composedtype a creator will be opened within the organizer.
    
    Since:
    
    2.20
  - getDefaultValues
```
public static Map getDefaultValues(ComposedType composedType)
```
    Parameters:
    
    composedType -
    
    Returns:
    
    thr default value map of the composed typ
    
    Since:
    
    2.20
  - openItemSearch
```
public static void openItemSearch(ComposedType typeToSearch,
                                  ItemAcceptor itemAcceptor,
                                  ReferenceEditorNode referenceEditorNode,
                                  boolean autoPerform,
                                  Map presetValues)
```
    Opens a new window containing an item search.
    
    Parameters:
    
    typeToSearch - the ComposedType for which to search (including subtypes)
    
    itemAcceptor - the Chip which implements ItemAcceptor to receive the item(s) of this search via ItemAcceptor.setSelectedItems(List) (usually this is the chip that calls this method)
    
    referenceEditorNode - a ReferenceEditorNode which may modify the search conditions (may be null)
    
    autoPerform - if true the search will automatically started
    
    presetValues - a map containing preset values for the search. attribute qualifiers must be mapped to values and the appropriate condition chips will be added and filled
  - openItemSearch
```
public static void openItemSearch(ComposedType typeToSearch,
                                  ItemAcceptor itemAcceptor,
                                  ReferenceEditorNode referenceEditorNode,
                                  boolean autoPerform,
                                  Map presetValues,
                                  ComposedType presetSearchType)
```
    Opens a new window containing an item search.
    
    Parameters:
    
    typeToSearch - the ComposedType for which to search (including subtypes)
    
    itemAcceptor - the Chip which implements ItemAcceptor to receive the item(s) of this search via ItemAcceptor.setSelectedItems(List) (usually this is the chip that calls this method)
    
    referenceEditorNode - a ReferenceEditorNode which may modify the search conditions (may be null)
    
    autoPerform - if true the search will automatically started
    
    presetValues - a map containing preset values for the search. attribute qualifiers must be mapped to values and the appropriate condition chips will be added and filled
    
    presetSearchType - if you want to preset another composedtype than the actual 'type to search' you can do so by setting the presetSearchType
    
    Since:
    
    2.20
  - setPresetConditions
```
public static void setPresetConditions(GenericSearchChip searchChip,
                                       Map presetValues)
```
  - isContainedInMainWindow
```
public static boolean isContainedInMainWindow(AbstractChip chip)
```
    Returns true if the given chip is contained in the main window. The 'main window' is the window containing the hmc explorer tree and the organizer.
    
    Returns:
    
    true if the given chip is contained in the main window
    
    Since:
    
    2.10
  - getClipboard
```
public static Object getClipboard()
```
    Returns the value currently contained in the clipboard. Additionally to just calling DisplayState.getClipboard() this method also checks for validity of contained Item objects (to prevent 'object no longer valid' errors, for example).
    
    Returns:
    
    the value currently contained in the clipboard.
    
    Since:
    
    2.20
  - getSingleClipboardItem
```
public static Item getSingleClipboardItem()
```
    Returns an Item contained in the clipboard. If there is a single object contained in the clipboard which is an Item then this will be returned. If there is a Collection in the clipboard then the first Item in this collection will be returned. In all other cases null will be returned.
    
    Returns:
    
    an Item contained in the clipboard.
    
    Since:
    
    2.20
  - getSingleClipboardItem
```
public static Item getSingleClipboardItem(ComposedType type)
```
    Returns an Item contained in the clipboard which is an instance of the specified ComposedType. If there is a single object contained in the clipboard which is an Item of the correct type then this will be returned. If there is a Collection in the clipboard then the first Item of the correct type in this collection will be returned. In all other cases null will be returned.
    
    Returns:
    
    an Item contained in the clipboard.
    
    Since:
    
    2.20
  - getValueMap
```
public static Map<String,Object> getValueMap(GenericItemChip itemChip,
                                             ComposedType type,
                                             Collection<HMCHelper.AttributePreset> presets)
```
    Parameters:
    
    itemChip -
    
    type -
    
    presets -
    
    Returns:
    
    the value map
    
    Since:
    
    2.20
  - getVariantAttributeDescriptors
```
public static Collection getVariantAttributeDescriptors(ComposedType type)
```
    For the given ComposedType all VariantAttributeDescriptors (if any) are returned. This method looks for AttributeDescriptors which type code is "VariantAttributeDescriptor" so it won't work with subtypes of VariantAttributeDescriptor!
  - extractBooleanAttribute
```
public static boolean extractBooleanAttribute(Map<String,String> attributes,
                                              String attributeName,
                                              boolean defaultValue)
```
    Since:
    
    3.00 (beta1)
  - extractIntegerAttribute
```
public static int extractIntegerAttribute(Map<String,String> attributes,
                                          String attributeName,
                                          int defaultValue)
```
    Since:
    
    3.00 (beta1)
  - extractStringAttribute
```
public static String extractStringAttribute(Map<String,String> attributes,
                                            String attributeName,
                                            String defaultValue)
```
    Since:
    
    3.00 (beta1)
  - findSavedQuery
```
public static SavedQuery findSavedQuery(ComposedType type,
                                        String code)
```
    Finds and returns a SavedQuery which result type is of the given type (or one of its supertypes) and which code is equal to the given code.
    
    Parameters:
    
    type - the result type for which to search a saved query
    
    code - the code for which to search
    
    Returns:
    
    a SavedQuery which result type is of the given type (or one of its supertypes) and which code is equal to the given code.
    
    Since:
    
    3.0 M1
  - getSavedQueries
```
public static List<SavedQuery> getSavedQueries(ComposedType type)
```
    For the given ComposedType all available SavedQueries (with this type as return type) are returned.
    
    Parameters:
    
    type - the ComposedType for which to search all savedqueries
    
    Returns:
    
    a list of SavedQuery items for the given type
  - searchItems
```
public static int searchItems(String argument,
                              Collection<Item> results,
                              ComposedType searchType,
                              Collection<String> searchAttributes,
                              Operator condition,
                              int range,
                              boolean includeSubTypes)
```
    Searches items based on the given search argument. The argument will be used to create a 'contains' condition for all configured attributes. If the argument is null or empty, all items will be returned. The access rights of the current session user will be considered. So if the current user may not see items of the given search type or any of it subtypes then the appropriate items will be filtered from the result.
    
    Parameters:
    
    argument - the search string which will be used for a 'contains' condition
    
    results - a collection which will be filled with the resulting items
    
    searchType - the (super-)type of the items which should be found
    
    searchAttributes - a list of attribute qualifiers for which the search string (the 'argument') should be applied
    
    condition - a search Operator like Operator.OR (when using more than one search attribute this operator is used to combine these)
    
    range - the maximum search count
    
    includeSubTypes - if true all subtypes are included in the search, if false only items of the exact given searchType are searched
    
    Returns:
    
    the total number of search results (which can be more than the number of objects returned if there are more than allowed
    
    Since:
    
    3.0 M2
  - searchItems
```
public static int searchItems(String argument,
                              Collection<Item> results,
                              ComposedType searchType,
                              Collection<String> searchAttributes,
                              Map<String,Object> presetValues,
                              Operator condition,
                              int range,
                              boolean includeSubTypes)
```
    Searches items based on the given search argument. The argument will be used to create a 'contains' condition for all configured attributes. If the argument is null or empty, all items will be returned. The access rights of the current session user will be considered. So if the current user may not see items of the given search type or any of it subtypes then the appropriate items will be filtered from the result.
    
    Parameters:
    
    argument - the search string which will be used for a 'contains' condition
    
    results - a collection which will be filled with the resulting items
    
    searchType - the (super-)type of the items which should be found
    
    searchAttributes - a list of attribute qualifiers for which the search string (the 'argument') should be applied
    
    presetValues - map of attribute qualifiers to preset values for these attributes (for given searchType). The search will be restricted to results where the attribute values equal their presets.
    
    condition - a search Operator like Operator.OR (when using more than one search attribute this operator is used to combine these)
    
    range - the maximum search count
    
    includeSubTypes - if true all subtypes are included in the search, if false only items of the exact given searchType are searched
    
    Returns:
    
    the total number of search results (which can be more than the number of objects returned if there are more than allowed
    
    Since:
    
    3.0 M3
  - xssEncodeHTML
```
public static String xssEncodeHTML(String s)
```
    Thin wrapper method around XSSEncoder#encodeHTML(String) to avoid catching exceptions all over the place!
  - xssEncodeHTMLPreservingIndentation
```
public static String xssEncodeHTMLPreservingIndentation(String str)
```

Class HMCHelper

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG_DIVIDER

NONE

USE_DB_STRUCTURE

SESSION_STRUCTURE_TIMESTAMP

HMC_DEVELOPERMODE

HMC_NAMESPACE

SCHEMA_URL_PROPERTY

DEFAULT_DATE_PATTERN

DATE_PATTERN

DEFAULT_TIME_PATTERN

TIME_PATTERN

MONTH_JAN

MONTH_FEB

MONTH_MAR

MONTH_APR

MONTH_MAY

MONTH_JUN

MONTH_JUL

MONTH_AUG

MONTH_SEP

MONTH_OCT

MONTH_NOV

MONTH_DEC

WEEKDAY_MO

WEEKDAY_TU

WEEKDAY_WE

WEEKDAY_TH

WEEKDAY_FR

WEEKDAY_SA

WEEKDAY_SU

Constructor Detail

HMCHelper

Method Detail

clearThreadLocals

getHMCContextFor

getXSSFilter

getXSSFilter

LogHeader

LogHeader

getPriceFormat

makeString

getLocale

getType

getType

getCustomerType

getCustomerType

getUserGroupType

getUserGroupType

getProductType

getProductType

getComposedTypeType

getComposedTypeType

getEnumerationValueType

getEnumerationValueType

getEmployeeType

getEmployeeType

getPrincipalType

getPrincipalType

getTitleType

getTitleType

getCountryType

getCountryType

getCurrencyType

getCurrencyType

getLanguageType

getLanguageType

getMediaType

getMediaType

getUnitType

getUnitType

getTaxType

getTaxType

getDiscountType