Package de.hybris.platform.odata2services.odata.schema.association

Class AbstractAssociationGenerator

java.lang.Object

de.hybris.platform.odata2services.odata.schema.association.AbstractAssociationGenerator

All Implemented Interfaces:

AssociationGenerator, SchemaElementGenerator<org.apache.olingo.odata2.api.edm.provider.Association,IntegrationObjectItemAttributeModel>

Direct Known Subclasses:

CollectionAssociationGenerator, OneToOneAssociationGenerator

public abstract class AbstractAssociationGenerator
extends java.lang.Object
implements AssociationGenerator

Constructor Summary

Constructors

Constructor	Description
AbstractAssociationGenerator()

Method Summary

Modifier and Type	Method	Description
protected TypeAttributeDescriptor	asDescriptor(IntegrationObjectItemAttributeModel attributeDefinitionModel)	Deprecated, for removal: This API element is subject to removal in a future version. no alternative method.
protected void	checkIsApplicablePrecondition(IntegrationObjectItemAttributeModel attributeDefinitionModel)	Deprecated, for removal: This API element is subject to removal in a future version. no alternative method.
protected static boolean	falseIfNull(java.lang.Object attribute)
org.apache.olingo.odata2.api.edm.provider.Association	generate(TypeAttributeDescriptor attrDescriptor)	Generates an association for the referenced TypeAttributeDescriptor
java.lang.String	getAssociationName(IntegrationObjectItemAttributeModel attributeDefinitionModel)	Derives the association name from the given attribute definition model
java.lang.String	getAssociationName(TypeAttributeDescriptor descriptor)	Generates association name based on the the provided attribute descriptor.
protected org.apache.olingo.odata2.api.edm.EdmMultiplicity	getSourceCardinality(TypeAttributeDescriptor descriptor)	Determines cardinality of the source type presented in the specified attribute descriptor.
java.lang.String	getSourceRole(IntegrationObjectItemAttributeModel attributeDefinitionModel)	Derives the source role from the given attribute definition model
java.lang.String	getSourceRole(TypeAttributeDescriptor descriptor)	Generates an association source role.
protected org.apache.olingo.odata2.api.edm.EdmMultiplicity	getTargetCardinality(TypeAttributeDescriptor descriptor)	Determines cardinality of the target type presented in the specified attribute descriptor.
java.lang.String	getTargetRole(IntegrationObjectItemAttributeModel attributeDefinitionModel)	Derives the target role from the given attribute definition model
java.lang.String	getTargetRole(TypeAttributeDescriptor descriptor)	Generates an association target role.
protected java.lang.String	getTargetType(IntegrationObjectItemAttributeModel attributeModel)	Deprecated, for removal: This API element is subject to removal in a future version. convert the IntegrationObjectItemAttributeModel to a TypeAttributeDescriptor and use the getTargetType(TypeAttributeDescriptor) method.
protected java.lang.String	getTargetType(TypeAttributeDescriptor descriptor)	Generates an association target type.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.hybris.platform.odata2services.odata.schema.association.AssociationGenerator

generate, isApplicable, isApplicable

Constructor Detail

AbstractAssociationGenerator

public AbstractAssociationGenerator()

Method Detail

generate

public org.apache.olingo.odata2.api.edm.provider.Association generate(TypeAttributeDescriptor attrDescriptor)

Description copied from interface: AssociationGenerator

Generates an association for the referenced TypeAttributeDescriptor

Specified by:

generate in interface AssociationGenerator

Parameters:

attrDescriptor - the integration object attribute descriptor

Returns:

the association

getSourceRole

public java.lang.String getSourceRole(IntegrationObjectItemAttributeModel attributeDefinitionModel)

Description copied from interface: AssociationGenerator

Derives the source role from the given attribute definition model

Specified by:

getSourceRole in interface AssociationGenerator

Parameters:

attributeDefinitionModel - the integration object attribute definition model

Returns:

the source role

getTargetRole

public java.lang.String getTargetRole(IntegrationObjectItemAttributeModel attributeDefinitionModel)

Description copied from interface: AssociationGenerator

Derives the target role from the given attribute definition model

Specified by:

getTargetRole in interface AssociationGenerator

Parameters:

attributeDefinitionModel - the integration object attribute definition model

Returns:

the target role

getAssociationName

public java.lang.String getAssociationName(IntegrationObjectItemAttributeModel attributeDefinitionModel)

Description copied from interface: AssociationGenerator

Derives the association name from the given attribute definition model

Specified by:

getAssociationName in interface AssociationGenerator

Parameters:

attributeDefinitionModel - the integration object attribute definition model

Returns:

the association name

checkIsApplicablePrecondition

@Deprecated(since="1905.08-CEP",
            forRemoval=true)
protected void checkIsApplicablePrecondition(IntegrationObjectItemAttributeModel attributeDefinitionModel)

Deprecated, for removal: This API element is subject to removal in a future version.

no alternative method. The DefaultTypeAttributeDescriptor.create validates the appropriate precondition. A IntegrationObjectItemAttributeModel cannot possibly exist with a null attribute descriptor.

Runs safety checks on the specified attribute definition model, to make sure it can be analyzed by the AssociationGenerator.isApplicable(IntegrationObjectItemAttributeModel) method. Specifically it checks the the model is not null and contains an AttributeDescriptorModel.

Parameters:

attributeDefinitionModel - a model to analyze

getAssociationName

public java.lang.String getAssociationName(TypeAttributeDescriptor descriptor)

Generates association name based on the the provided attribute descriptor.

Specified by:

getAssociationName in interface AssociationGenerator

Parameters:

descriptor - a descriptor to generate the association name for.

Returns:

name of the descriptor in "FK_<item_type>_<attribute_type>" format, where item_type is the type containing the attribute descriptor and attribute_type is the type of the attribute values or, in other words, type referenced by the attribute.

asDescriptor

@Deprecated(since="1905.08-CEP",
            forRemoval=true)
protected TypeAttributeDescriptor asDescriptor(IntegrationObjectItemAttributeModel attributeDefinitionModel)

Deprecated, for removal: This API element is subject to removal in a future version.

no alternative method.

Converts attribute model to an attribute descriptor.

Parameters:

attributeDefinitionModel - a model to convert.

Returns:

attribute descriptor for the specified attribute model.

getSourceRole

public java.lang.String getSourceRole(TypeAttributeDescriptor descriptor)

Generates an association source role.

Specified by:

getSourceRole in interface AssociationGenerator

Parameters:

descriptor - an attribute descriptor to generate the source role for.

Returns:

type code of the TypeDescriptor containing the attribute descriptor.

See Also:

TypeAttributeDescriptor.getTypeDescriptor(), TypeDescriptor.getItemCode()

getTargetRole

public java.lang.String getTargetRole(TypeAttributeDescriptor descriptor)

Generates an association target role.

Specified by:

getTargetRole in interface AssociationGenerator

Parameters:

descriptor - an attribute descriptor to generate the target role from.

Returns:

type code of the TypeDescriptor referenced by the attribute descriptor (type of the attribute values) or the attribute name if the source type is the same as the target type in the association.

See Also:

TypeAttributeDescriptor.getAttributeType(), TypeDescriptor.getItemCode(), TypeAttributeDescriptor.getAttributeName()

getTargetType

protected java.lang.String getTargetType(TypeAttributeDescriptor descriptor)

Generates an association target type.

Parameters:

descriptor - an attribute descriptor to generate the target type from.

Returns:

type code of the TypeDescriptor referenced by the attribute descriptor (type of the attribute values).

See Also:

TypeAttributeDescriptor.getAttributeType(), TypeDescriptor.getItemCode()

getTargetType

@Deprecated(since="1905.08-CEP",
            forRemoval=true)
protected java.lang.String getTargetType(IntegrationObjectItemAttributeModel attributeModel)

Deprecated, for removal: This API element is subject to removal in a future version.

convert the IntegrationObjectItemAttributeModel to a TypeAttributeDescriptor and use the getTargetType(TypeAttributeDescriptor) method.

Generates an association target type.

Parameters:

attributeModel - an attribute descriptor to generate the target type from.

Returns:

type code of the TypeDescriptor referenced by the attribute descriptor (type of the attribute values).

See Also:

TypeAttributeDescriptor.getAttributeType(), TypeDescriptor.getItemCode()

getSourceCardinality

protected org.apache.olingo.odata2.api.edm.EdmMultiplicity getSourceCardinality(TypeAttributeDescriptor descriptor)

Determines cardinality of the source type presented in the specified attribute descriptor. Normally the source type is the item type containing the attribute.

Parameters:

descriptor - descriptor to derive the cardinality from

Returns:

multiplicity

getTargetCardinality

protected org.apache.olingo.odata2.api.edm.EdmMultiplicity getTargetCardinality(TypeAttributeDescriptor descriptor)

Determines cardinality of the target type presented in the specified attribute descriptor. Normally the target type is the item type returned by the attribute.

Parameters:

descriptor - descriptor to derive the cardinality from

Returns:

multiplicity

falseIfNull

protected static boolean falseIfNull(java.lang.Object attribute)