de.hybris.platform.hmc.generic.nodes

Class StructureLoader

java.lang.Object

org.xml.sax.helpers.DefaultHandler

de.hybris.platform.hmc.generic.nodes.StructureLoader

All Implemented Interfaces:

Serializable, ContentHandler, DTDHandler, EntityResolver, ErrorHandler

public class StructureLoader
extends DefaultHandler
implements Serializable

Loads the configuration from the XML file.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_DECLARATION_MODE
static String	DEFAULT_TYPE_DECLARATION_MODE
static String	SESSION_CUSTOM_LOADER
static String	SESSION_USER_PK
static SingletonCreator.Creator<StructureLoader>	SINGLETON_CREATOR
static String	TYPE_DECLARATION_MODE_APPEND
static String	TYPE_DECLARATION_MODE_DELETE
static String	TYPE_DECLARATION_MODE_REPLACE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StructureLoader()
protected	StructureLoader(StructureLoaderData presetData, Set<PK> customStructureUserGroupPKs, boolean initialized)

Method Summary

Modifier and Type	Method and Description
List<SearchResultActionNode>	addSearchResultActionsInternal(ComposedType type)
static void	assureLoaded(JaloSession jaloSession, HttpServletRequest request)
protected void	checkOutdated(JaloSession jaloSession, HttpServletRequest request, boolean productiveMode)
void	checkToolbarActions(JaloSession session)
protected Node	createNode(Node parent, String name, Map<String,String> attributes)
static String	createTimeStamp() Returns a unique timestamp.
void	dumpStructure(OutputStream outputStream)
void	endElement(String uri, String localName, String qName)
void	error(SAXParseException exception)
void	fatalError(SAXParseException exception)
GroupNode	findGroupNode(TreeNode root, String name)
TabNode	findTabNode(Node root, String id)
static AttributeChipNode	getAttributeChipNode(AttributeDescriptor desc)
static Class	getAttributeDisplayClass(Class attributeClass) Returns a Class object of the attribute display chip which is mapped to the given attribute type class.
static Class	getAttributeEditorClass(String editorType) Returns a Class object of the attribute editor chip which is mapped to the given editor type string.
static AttributeTypeNode	getAttributeTypeNode(Class attributeClass) Returns the AttributeTypeNode which contains the default configuration of the display- and editorchips of the given attribute class.
static Map<Class<?>,Class<?>>	getClassMappings(Class<?> mappingNodeClass) Returns the classmappings for the given mappingnode class.
protected Map<Class<?>,Class<?>>	getClassMappingsInternal(Class<?> mappingNodeClass)
protected ConfigurationNode	getConfigurationNode()
static CreateAction	getCreateAction()
protected StructureLoaderData	getData()
static Map<String,String>	getDefaultEditorTypes()
static DefaultReferenceNode	getDefaultReferenceNode(ComposedType type)
static int	getDefaultSearchResultViewMode(ComposedType type)
static ClassConfigNode	getDisplayNode(Class attributeClass)
static EditorNode	getEditorNode(ComposedType type)
static EditorNode	getEditorNode(Item item)
static EssentialsNode	getEssentialsNode(ComposedType type)
static ExplorerNode	getExplorerLayout(ComposedType type)
static ExplorerTreeNode	getExplorerTreeNode()
static int	getExplorerTreeWidth() Returns the width of the explorer tree.
static String	getIcon(ComposedType type)
static Set<LabelNode>	getLabelNodes(ComposedType type, String labelname)
static Set<LabelNode>	getLabelNodes(String labelname)
static Set<LabelNode>	getLabelNodes(TypeNode typeNode, String labelname)
static LoadAction	getLoadAction()
static StructureLoader	getLoader()
String	getParseResult()
static String	getReferenceFinderAttributeName(ComposedType type)
static List<String>	getReferenceSearchAttributeNames(ComposedType type) In contrast to getReferenceFinderAttributeName(ComposedType) this method tries to extract several attribute names from the 'searchattribute' setting which are comma separated.
static RemoveAction	getRemoveAction()
protected static StructureLoader	getRootLoader()
static SaveAction	getSaveAction()
static SearchNode	getSearchNode(ComposedType type)
static List<SearchResultActionNode>	getSearchResultActions(ComposedType type) returns a List of SearchResultActionNodes for the given type
static ItemLayoutNode	getSearchResultItemLayoutNode(ComposedType type, int viewMode)
protected String	getTimestamp()
static List<ToolbarActionNode>	getToolbarActions() returns a List of ToolbarActionNodes
List<ToolbarActionNode>	getToolbarActionsInternal()
static List<TypeNode>	getToolbarCreateTypes() returns a List of TypeNodes
List<TypeNode>	getToolbarCreateTypesInternal()
static List	getTreeNodeChips(DisplayState displayState, Chip parent)
static ExplorableNode	getTreeViewExplorableNode(ComposedType type) Returns explorable node of the tree view section of the search result.
static TypeNode	getTypeNode(ComposedType composedType)
static Collection<TypeNode>	getTypeNodes() return Collection of TypeNodes.
Collection<TypeNode>	getTypeNodesInternal()
static boolean	hasLoader()
static boolean	hasWarnings()
boolean	isOutdated()
static boolean	isUsingDBForStructure()
protected boolean	isValidForUser(User user)
boolean	loadStructure(InputStream isToRead, String schemaURL) Starts the loading of throws structure from the specified stream.
boolean	loadStructure(String resourceName, String schemaURL) Starts the loading of structure from the specified file.
protected boolean	loadXML(InputStream isToRead, String schemaURL)
static EditorNode	modifyEditorNode(EditorNode toModify, String xmlCfg) Applies changes to an existing EditorNode defined within a given xml string.
void	printConfig(DisplayState displayState, String fileName)
void	printWarning(ComposedType type, String warning)
void	printWarning(String warning)
void	printWarnings()
void	replaceTabRefNodes(Node root)
protected void	restoreData(StructureLoaderData newData)
protected void	setTimestamp(String timestamp)
void	startElement(String uri, String localName, String qName, Attributes attributes)
protected Set<PK>	toPKSet(Set<UserGroup> grps)
String	toString()
static void	unsetCurrentLoader()
void	warning(SAXParseException exception)

Methods inherited from class org.xml.sax.helpers.DefaultHandler

characters, endDocument, endPrefixMapping, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TYPE_DECLARATION_MODE_APPEND

public static final String TYPE_DECLARATION_MODE_APPEND

See Also:

Constant Field Values

TYPE_DECLARATION_MODE_DELETE

public static final String TYPE_DECLARATION_MODE_DELETE

See Also:

Constant Field Values

TYPE_DECLARATION_MODE_REPLACE

public static final String TYPE_DECLARATION_MODE_REPLACE

See Also:

Constant Field Values

DEFAULT_TYPE_DECLARATION_MODE

public static final String DEFAULT_TYPE_DECLARATION_MODE

See Also:

Constant Field Values

DEFAULT_DECLARATION_MODE

public static final String DEFAULT_DECLARATION_MODE

See Also:

Constant Field Values

SESSION_CUSTOM_LOADER

public static final String SESSION_CUSTOM_LOADER

See Also:

Constant Field Values

SESSION_USER_PK

public static final String SESSION_USER_PK

See Also:

Constant Field Values

SINGLETON_CREATOR

public static final SingletonCreator.Creator<StructureLoader> SINGLETON_CREATOR

Constructor Detail

StructureLoader

protected StructureLoader()

StructureLoader

protected StructureLoader(StructureLoaderData presetData,
                          Set<PK> customStructureUserGroupPKs,
                          boolean initialized)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

isValidForUser

protected boolean isValidForUser(User user)

toPKSet

protected Set<PK> toPKSet(Set<UserGroup> grps)

isUsingDBForStructure

public static boolean isUsingDBForStructure()

Returns:

true if the structure (hmc.xml) is currently loaded from the database

isOutdated

public boolean isOutdated()

unsetCurrentLoader

public static void unsetCurrentLoader()

getTimestamp

protected String getTimestamp()

setTimestamp

protected void setTimestamp(String timestamp)

checkOutdated

protected void checkOutdated(JaloSession jaloSession,
                             HttpServletRequest request,
                             boolean productiveMode)

assureLoaded

public static void assureLoaded(JaloSession jaloSession,
                                HttpServletRequest request)

createTimeStamp

public static String createTimeStamp()

Returns a unique timestamp.

Returns:

a String containing a uniqe timestamp.

getData

protected StructureLoaderData getData()

restoreData

protected void restoreData(StructureLoaderData newData)

hasLoader

public static final boolean hasLoader()

getLoader

public static final StructureLoader getLoader()

getRootLoader

protected static final StructureLoader getRootLoader()

modifyEditorNode

public static EditorNode modifyEditorNode(EditorNode toModify,
                                          String xmlCfg)

Applies changes to an existing EditorNode defined within a given xml string. The existing node is not changed itself but copied, altered and returned. Please note that the newly created node does not become part of the current hmc configuration but exists only for temporary usage.

Parameters:

toModify -

xmlCfg -

Returns:

EditorNode

loadStructure

public boolean loadStructure(String resourceName,
                             String schemaURL)
                      throws IOException

Starts the loading of structure from the specified file.

Parameters:

resourceName - Name of the XML file containing the structure.

schemaURL - URL of the xsd file which will be used to validate the xml file.

Throws:

IOException

dumpStructure

public void dumpStructure(OutputStream outputStream)

Since:

2.3

loadStructure

public boolean loadStructure(InputStream isToRead,
                             String schemaURL)
                      throws IOException

Starts the loading of throws structure from the specified stream.

Parameters:

isToRead -

schemaURL -

Throws:

IOException

loadXML

protected boolean loadXML(InputStream isToRead,
                          String schemaURL)

getEssentialsNode

public static EssentialsNode getEssentialsNode(ComposedType type)

getEditorNode

public static EditorNode getEditorNode(Item item)

getEditorNode

public static EditorNode getEditorNode(ComposedType type)

getSearchResultItemLayoutNode

public static ItemLayoutNode getSearchResultItemLayoutNode(ComposedType type,
                                                           int viewMode)

getDefaultSearchResultViewMode

public static int getDefaultSearchResultViewMode(ComposedType type)

getTreeViewExplorableNode

public static ExplorableNode getTreeViewExplorableNode(ComposedType type)

Returns explorable node of the tree view section of the search result. May return null if not defined !!!

Parameters:

type -

Returns:

explorable node of the tree view section of the search result or null if not defined

getDefaultReferenceNode

public static DefaultReferenceNode getDefaultReferenceNode(ComposedType type)

getReferenceFinderAttributeName

public static String getReferenceFinderAttributeName(ComposedType type)

getReferenceSearchAttributeNames

public static List<String> getReferenceSearchAttributeNames(ComposedType type)

In contrast to getReferenceFinderAttributeName(ComposedType) this method tries to extract several attribute names from the 'searchattribute' setting which are comma separated. Especially the AutocompleteReferenceEditorChip can use more than one search attribute which it will use performing an OR search on all attributes (and showing the results using all given attributes).

Parameters:

type - the ComposedType for which to find the search attribute names

Returns:

list of search attribute names

Since:

3.0 M2

getExplorerLayout

public static ExplorerNode getExplorerLayout(ComposedType type)

getIcon

public static String getIcon(ComposedType type)

getSearchNode

public static SearchNode getSearchNode(ComposedType type)

getTypeNode

public static TypeNode getTypeNode(ComposedType composedType)

getAttributeChipNode

public static AttributeChipNode getAttributeChipNode(AttributeDescriptor desc)

getTreeNodeChips

public static List getTreeNodeChips(DisplayState displayState,
                                    Chip parent)

Returns:

List of GenericExplorerMenuTreeNodeChips

error

public void error(SAXParseException exception)
           throws SAXException

Specified by:

error in interface ErrorHandler

Overrides:

error in class DefaultHandler

Throws:

SAXException

fatalError

public void fatalError(SAXParseException exception)
                throws SAXException

Specified by:

fatalError in interface ErrorHandler

Overrides:

fatalError in class DefaultHandler

Throws:

SAXException

warning

public void warning(SAXParseException exception)
             throws SAXException

Specified by:

warning in interface ErrorHandler

Overrides:

warning in class DefaultHandler

Throws:

SAXException

getParseResult

public String getParseResult()

getConfigurationNode

protected ConfigurationNode getConfigurationNode()

getExplorerTreeNode

public static ExplorerTreeNode getExplorerTreeNode()

getExplorerTreeWidth

public static int getExplorerTreeWidth()

Returns the width of the explorer tree.

Returns:

the width of the explorer tree.

getTypeNodes

public static Collection<TypeNode> getTypeNodes()

return Collection of TypeNodes.

getTypeNodesInternal

public Collection<TypeNode> getTypeNodesInternal()

startElement

public void startElement(String uri,
                         String localName,
                         String qName,
                         Attributes attributes)
                  throws SAXException

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class DefaultHandler

Throws:

SAXException

getToolbarCreateTypes

public static List<TypeNode> getToolbarCreateTypes()

returns a List of TypeNodes

getToolbarCreateTypesInternal

public List<TypeNode> getToolbarCreateTypesInternal()

getToolbarActions

public static List<ToolbarActionNode> getToolbarActions()

returns a List of ToolbarActionNodes

getSearchResultActions

public static List<SearchResultActionNode> getSearchResultActions(ComposedType type)

returns a List of SearchResultActionNodes for the given type

getSaveAction

public static SaveAction getSaveAction()

getLoadAction

public static LoadAction getLoadAction()

getCreateAction

public static CreateAction getCreateAction()

getRemoveAction

public static RemoveAction getRemoveAction()

Since:

2.10

getToolbarActionsInternal

public List<ToolbarActionNode> getToolbarActionsInternal()

addSearchResultActionsInternal

public List<SearchResultActionNode> addSearchResultActionsInternal(ComposedType type)

checkToolbarActions

public void checkToolbarActions(JaloSession session)

endElement

public void endElement(String uri,
                       String localName,
                       String qName)
                throws SAXException

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class DefaultHandler

Throws:

SAXException

replaceTabRefNodes

public void replaceTabRefNodes(Node root)

findTabNode

public TabNode findTabNode(Node root,
                           String id)

findGroupNode

public GroupNode findGroupNode(TreeNode root,
                               String name)

createNode

protected Node createNode(Node parent,
                          String name,
                          Map<String,String> attributes)
                   throws NodeCreationFailedException

Throws:

NodeCreationFailedException

printConfig

public void printConfig(DisplayState displayState,
                        String fileName)
                 throws IOException

Throws:

IOException

printWarning

public void printWarning(String warning)

printWarning

public void printWarning(ComposedType type,
                         String warning)

getDefaultEditorTypes

public static Map<String,String> getDefaultEditorTypes()

getClassMappings

public static Map<Class<?>,Class<?>> getClassMappings(Class<?> mappingNodeClass)

Returns the classmappings for the given mappingnode class. E.g. returns a map of all AttributeDisplayMappingNodes if the parameter AttributeDisplayMappingNodes.class is used.

Returns:

the classmappings for the given class, null if there are no mappings found

getClassMappingsInternal

protected Map<Class<?>,Class<?>> getClassMappingsInternal(Class<?> mappingNodeClass)

getAttributeEditorClass

public static Class getAttributeEditorClass(String editorType)

Returns a Class object of the attribute editor chip which is mapped to the given editor type string. classes as with the attribute display chips

getAttributeDisplayClass

public static Class getAttributeDisplayClass(Class attributeClass)

Returns a Class object of the attribute display chip which is mapped to the given attribute type class.

getAttributeTypeNode

public static AttributeTypeNode getAttributeTypeNode(Class attributeClass)

Returns the AttributeTypeNode which contains the default configuration of the display- and editorchips of the given attribute class.

getDisplayNode

public static ClassConfigNode getDisplayNode(Class attributeClass)

printWarnings

public void printWarnings()

getLabelNodes

public static Set<LabelNode> getLabelNodes(String labelname)

getLabelNodes

public static Set<LabelNode> getLabelNodes(ComposedType type,
                                           String labelname)

getLabelNodes

public static Set<LabelNode> getLabelNodes(TypeNode typeNode,
                                           String labelname)

hasWarnings

public static boolean hasWarnings()