de.hybris.platform.dataservicesbackoffice.audit.impl

Class DefaultAuditReportXSDGenerationService

java.lang.Object

de.hybris.platform.dataservicesbackoffice.audit.impl.DefaultAuditReportXSDGenerationService

All Implemented Interfaces:

AuditReportXSDGenerationService

public class DefaultAuditReportXSDGenerationService
extends java.lang.Object
implements AuditReportXSDGenerationService

Default implementation for AuditReportXSDGenerationService

Constructor Summary

Constructors

Constructor and Description
DefaultAuditReportXSDGenerationService()

Method Summary

Modifier and Type	Method and Description
protected void	addMandatoryAttributes(Type auditConfigType, TopLevelComplexType complexType, java.util.List<Type> allTypes, Schema schema) Added tne mandatory attribute for the type system item model attribute into the complex type.
protected void	addUniqueAttributes(Type auditConfigType, TopLevelComplexType complexType) First, Java primitive type is added as unique attribute if there is no unique attribute is defined in audit report config.
protected void	buildAtomicAttributes(Type auditConfigType, TopLevelComplexType complexType) Build the atomic attributes into the given complex type for audit config type
protected void	buildComplexType(java.util.List<Type> allTypes, Schema schema, Type auditConfigType) Build the complex type from given audit config type, and add into the given schema
protected TopLevelComplexType	buildLocalizedHybrisField() Build the localized hybris field complex type.
protected void	buildReferenceAttributes(Type auditConfigType, TopLevelComplexType complexType) Build the reference attributes into the given complex type for audit config type
protected void	buildRelationAttributes(Type auditConfigType, TopLevelComplexType complexType) Build the relation attributes into the given complex type for audit config type
protected TopLevelElement	buildRootElement(AuditReportConfig auditReportConfig) Build root level element by given audit report config.
protected TopLevelComplexType	buildSimpleHybrisField() Build the simple hybris field complex type.
protected void	buildVirtualAttributes(Type auditConfigType) Log the virtual attribute is not added, and not supported yet.
protected java.lang.String	cleanXSD(java.lang.String xsdString) Remove the empty xmlns if exists.
protected LocalElement	createAtomicAttributeElement(AttributeDescriptorModel attr, Type type) Create LocalElement object for atomic attribute.
protected Attribute	createAttribute(java.lang.String name, java.lang.String type) build an attribute element.
protected LocalElement	createElement(java.lang.String name, java.lang.String type, boolean isMany, boolean isUnique) Create a local element object from the ObjectFactory with given name, type
protected Keybase	createKeybase(java.lang.String type, java.lang.String attr) Create a keybase element by given type and attribute.
protected java.util.List<AttributeDescriptorModel>	findMandatoryAttributes(Type auditConfigType, java.lang.String typeCode) Return the list of AttributeDescriptorModel which is mandatory by given audit config type and type code.
protected java.util.List<AttributeDescriptorModel>	findUniqueAttributes(Type auditConfigType, java.lang.String typeCode) Return the list of AttributeDescriptorModel which is unique by given audit config type and type code.
java.lang.String	generate(java.lang.String auditConfigName) Genreate the XSD string.
protected AuditConfigService	getAuditConfigService()
protected TypeService	getTypeService()
protected boolean	hasUniqueAttribute(TopLevelComplexType complexType) Check if the given complex type has the unique constraint.
protected boolean	isAtomicAttribute(java.lang.String attributeTypeCode) Return if the given attribute type code is an atomic attribute.
protected boolean	isAttributeInAuditConfig(Type auditConfigType, AttributeDescriptorModel attr) check if the given type attribute is defined in audit config type.
protected boolean	isRequiredMandatoryAttribute(AttributeDescriptorModel attr) The mandatory attributes need to be persisted, without default value, not PK.
protected boolean	isTypeCodeInAuditConfig(java.util.List<Type> allTypes, java.lang.String typeCode) If the given typeCode exists in AuditReportConfig.
protected boolean	isTypeCodeInSchema(Schema schema, java.lang.String typeCode) If the given typeCode exists in given schema.
protected java.lang.String	marshaller(Schema schema) Marshaller the given schema to xsd output.
void	setAuditConfigService(AuditConfigService auditConfigService)
void	setTypeService(TypeService typeService)
protected java.lang.String	uniqueKey(java.lang.String type, java.lang.String attr) Generate the uniqueKey name string.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultAuditReportXSDGenerationService

public DefaultAuditReportXSDGenerationService()

Method Detail

generate

public java.lang.String generate(java.lang.String auditConfigName)
                          throws javax.xml.bind.JAXBException

Description copied from interface: AuditReportXSDGenerationService

Genreate the XSD string.

Specified by:

generate in interface AuditReportXSDGenerationService

Parameters:

auditConfigName - the audit config name

Returns:

the XSD string

Throws:

javax.xml.bind.JAXBException - exception

buildRootElement

protected TopLevelElement buildRootElement(AuditReportConfig auditReportConfig)

Build root level element by given audit report config.

Parameters:

auditReportConfig - the audit report config

Returns:

top level element object

buildComplexType

protected void buildComplexType(java.util.List<Type> allTypes,
                                Schema schema,
                                Type auditConfigType)

Build the complex type from given audit config type, and add into the given schema

Parameters:

allTypes - the all types from the auditReportConfig

schema - the schema object

auditConfigType - the audit config type

buildVirtualAttributes

protected void buildVirtualAttributes(Type auditConfigType)

Log the virtual attribute is not added, and not supported yet.

Parameters:

auditConfigType - audit config type

buildAtomicAttributes

protected void buildAtomicAttributes(Type auditConfigType,
                                     TopLevelComplexType complexType)

Build the atomic attributes into the given complex type for audit config type

Parameters:

auditConfigType - audit config type

complexType - complex type

buildReferenceAttributes

protected void buildReferenceAttributes(Type auditConfigType,
                                        TopLevelComplexType complexType)

Build the reference attributes into the given complex type for audit config type

Parameters:

auditConfigType - audit config type

complexType - complex type

buildRelationAttributes

protected void buildRelationAttributes(Type auditConfigType,
                                       TopLevelComplexType complexType)

Build the relation attributes into the given complex type for audit config type

Parameters:

auditConfigType - audit config type

complexType - complex type

marshaller

protected java.lang.String marshaller(Schema schema)
                               throws javax.xml.bind.JAXBException

Marshaller the given schema to xsd output.

Parameters:

schema - schema

Returns:

xsd String

Throws:

javax.xml.bind.JAXBException - exception

cleanXSD

protected java.lang.String cleanXSD(java.lang.String xsdString)

Remove the empty xmlns if exists.

Parameters:

xsdString - XSD

Returns:

the cleaned XSD string

addUniqueAttributes

protected void addUniqueAttributes(Type auditConfigType,
                                   TopLevelComplexType complexType)

First, Java primitive type is added as unique attribute if there is no unique attribute is defined in audit report config.

Parameters:

auditConfigType - the audit config type

complexType - the top level complex type

addMandatoryAttributes

protected void addMandatoryAttributes(Type auditConfigType,
                                      TopLevelComplexType complexType,
                                      java.util.List<Type> allTypes,
                                      Schema schema)

Added tne mandatory attribute for the type system item model attribute into the complex type.

Parameters:

auditConfigType - audit config type

complexType - the complex type

allTypes - the all types from audit config

schema - the schema

isAtomicAttribute

protected boolean isAtomicAttribute(java.lang.String attributeTypeCode)

Return if the given attribute type code is an atomic attribute.

Parameters:

attributeTypeCode - attribute type code

Returns:

boolean

findUniqueAttributes

protected java.util.List<AttributeDescriptorModel> findUniqueAttributes(Type auditConfigType,
                                                                        java.lang.String typeCode)

Return the list of AttributeDescriptorModel which is unique by given audit config type and type code.

Parameters:

auditConfigType - audit config type

typeCode - type code

Returns:

list of unique attributes

findMandatoryAttributes

protected java.util.List<AttributeDescriptorModel> findMandatoryAttributes(Type auditConfigType,
                                                                           java.lang.String typeCode)

Return the list of AttributeDescriptorModel which is mandatory by given audit config type and type code.

Parameters:

auditConfigType - audit config type

typeCode - type code

Returns:

list of mandatory attributes

isTypeCodeInAuditConfig

protected boolean isTypeCodeInAuditConfig(java.util.List<Type> allTypes,
                                          java.lang.String typeCode)

If the given typeCode exists in AuditReportConfig.

Parameters:

allTypes - all types in AuditReportConfig

typeCode - the type code

Returns:

boolean

isTypeCodeInSchema

protected boolean isTypeCodeInSchema(Schema schema,
                                     java.lang.String typeCode)

If the given typeCode exists in given schema.

Parameters:

schema - generated schema

typeCode - the type code

Returns:

boolean

isAttributeInAuditConfig

protected boolean isAttributeInAuditConfig(Type auditConfigType,
                                           AttributeDescriptorModel attr)

check if the given type attribute is defined in audit config type.

Parameters:

auditConfigType - the audit config type

attr - the type system attribute model

Returns:

boolean

isRequiredMandatoryAttribute

protected boolean isRequiredMandatoryAttribute(AttributeDescriptorModel attr)

The mandatory attributes need to be persisted, without default value, not PK.

Parameters:

attr - AttributeDescriptorModel

Returns:

is required to be populated

hasUniqueAttribute

protected boolean hasUniqueAttribute(TopLevelComplexType complexType)

Check if the given complex type has the unique constraint.

Parameters:

complexType - complex type

Returns:

boolean

createElement

protected LocalElement createElement(java.lang.String name,
                                     java.lang.String type,
                                     boolean isMany,
                                     boolean isUnique)

Create a local element object from the ObjectFactory with given name, type

Parameters:

name - element name

type - element type

isMany - is the element is collection

isUnique - is the element has unique constraint

Returns:

localElement object

createAtomicAttributeElement

protected LocalElement createAtomicAttributeElement(AttributeDescriptorModel attr,
                                                    Type type)

Create LocalElement object for atomic attribute.

Parameters:

attr - the attribute description model

type - the type object of the AuditConfigType

Returns:

the localElement object

createKeybase

protected Keybase createKeybase(java.lang.String type,
                                java.lang.String attr)

Create a keybase element by given type and attribute.

Parameters:

type - type code

attr - attribute name

Returns:

keybase object

uniqueKey

protected java.lang.String uniqueKey(java.lang.String type,
                                     java.lang.String attr)

Generate the uniqueKey name string.

Parameters:

type - uniquekey type

attr - uniquekey attribute name

Returns:

uniqueKey name string

buildSimpleHybrisField

protected TopLevelComplexType buildSimpleHybrisField()

Build the simple hybris field complex type.

buildLocalizedHybrisField

protected TopLevelComplexType buildLocalizedHybrisField()

Build the localized hybris field complex type.

createAttribute

protected Attribute createAttribute(java.lang.String name,
                                    java.lang.String type)

build an attribute element.

Parameters:

name - attribute name

type - attribute type

getTypeService

protected TypeService getTypeService()

setTypeService

public void setTypeService(TypeService typeService)

getAuditConfigService

protected AuditConfigService getAuditConfigService()

setAuditConfigService

public void setAuditConfigService(AuditConfigService auditConfigService)