com.onwbp.adaptation
Class Adaptation

java.lang.Object
  com.onwbp.adaptation.ReadContext
      com.onwbp.adaptation.Adaptation

public class Adaptation

extends ReadContext

Provides a read-only access facade to Master Data values.

An adaptation represents either a XML Schema instance or a table occurrence (see Table definition).

Adaptations Tree and Inheritance

An adaptation has a parent adaptation (unless it is a root) and it can have children. Moreover common Master Data values can be factorized, this is the inheritance mechanism.

An adaptations inherits the values it does not define itself from its parent adaptation. This process is recursive, possibly up to the node's default value, that can be specified in associated XML Schema. If schema node itself does not define a default value, null is then returned.

Access to a value

Values in an adaptation are organized in a tree structure conforming to the underlying Adaptation Model (XML Schema document). Each value is accessed by means of a path. For reliability and performance, it is advised to use path generated as Java constants (see schema bindings).

Only terminal adaptation nodes hold actually values.

The interface ValueContext provides equivalent access functionalities. However an absolute path is not interpreted the same way by both type:

• For a ValueContext, an absolute path always begins at the root of the schema instance (even if it is a table occurrence).
• For an Adaptation, an absolute path always begins at the root node of the adaptation, that is, if the adaptation is a table occurrence, it begins at the occurrence root, not at the root of the schema instance.

See Also:

ValueContext

Field Summary

Fields inherited from class com.onwbp.adaptation.ReadContext

KEY

Method Summary

ActivationStatus	checkActivable() Deprecated. This method has been replaced by getValidationReport().
AdaptationName	getAdaptationName() Returns the name that uniquely identifies this adaptation in the repository.
AdaptationNode	getAdaptationNode(Path aPath) Deprecated. Replaced by getSchemaNode().
Adaptation	getContainer() If this adaptation is a table occurrence, returns the instance that contains it; returns null if this adaptation is an instance.
AdaptationTable	getContainerTable() If this is an occurrence, returns the table that contains it; returns null if this is an instance.
String	getDescription(Locale aLocale) Returns the descption corresponding to the given locale.
Profile	getDistributor() Returns the distributor of this adaptation, null if it is not an agreement or under an agreement.
com.onwbp.core.org.OrganizationName	getDistributorName() Deprecated.
AdaptationHome	getHome() Returns the home which contains this instance.
String	getLabel(Locale aLocale) Returns the instance label corresponding to the given locale.
String	getLabelOrName(Locale aLocale) Returns the instance label corresponding to the given locale.
UserReference	getLastUser() Returns the last user who has modified the adaptation.
String	getModuleName() Returns the name of the module that holds the schema document.
DefinitionMode	getOccurrenceDefinitionMode() Returns the definition mode of this occurrence.
PrimaryKey	getOccurrencePrimaryKey() Returns the primary key of this occurrence.
Profile	getProvider() Returns the owner of this adaptation.
com.onwbp.core.org.OrganizationName	getProviderName() Deprecated.
SchemaLocation	getSchemaLocation() Returns the location of the schema document.
SchemaNode	getSchemaNode() Returns the root schema node of this adaptation.
Date	getTimeOfCreation() Returns the time of the creation of this adaptation.
Date	getTimeOfLastModification() Returns the time of the last modification of this adaptation.
AdaptationReference	getTreeReference() Returns the name that uniquely identifies the tree of this adaptation in the repository.
Adaptation	getUpToDateInstance() Returns null if this instance has been deleted.
String	getUrlResourceRelative(Path aPath) Deprecated.
ValidationReport	getValidationReport() Returns the validation status of this instance regarding its schema definition.
ValidationReport	getValidationReport(boolean ensureActivation) Returns the validation status of this instance regarding its schema definition.
Object	getValueWithoutResolution(Path aPath) Returns the own value hold by the node specified.
boolean	isActivated() Returns true if this adaptation is activated.
boolean	isAgreement() Returns true if this adaptation is an agreement between the provider and a distributor, false otherwise.
boolean	isAgreementDescendant() Returns true if this adaptation has an agreement in its ancestors, false otherwise.
boolean	isDeleted() Returns true if this adaptation has been deleted.
boolean	isEditionOfRelease() Deprecated. Replaced by the method isNewOrModifiedInCurrentBranch().
boolean	isNewOrModifiedInCurrentBranch() Returns true if we are in a branch and, regarding the initial version of this branch, this adaptation is newly created or it has been updated.
boolean	isObsolete() Deprecated. Replaced by the method isDeleted().
boolean	isOccurrenceHidden() Returns true if this adaptation is a table occurrence that is in occulting mode or in edition-delete state.
boolean	isOccurrenceInheriting() Returns true if this adaptation is a table ocurrence in inherit mode.
boolean	isOccurrenceOcculting() Returns true if this adaptation is a table ocurrence in occulting mode.
boolean	isRelease() Deprecated. Replaced by the opposite result of method isNewOrModifiedInCurrentBranch().
boolean	isRootAdaptation() Returns true if this adaptation is root (it has no parent adaptation).
boolean	isSchemaDefinitionCompliant(boolean ensureActivation) Returns true if the validation of this instance is correct regarding its schema definition.
boolean	isSchemaInstance() Returns true if this adaptation is a schema instance, not a table occurrence.
boolean	isTableOccurrence() Returns true if this adaptation is a table occurrence, not a schema instance.
boolean	isTemporaryActivation() Tests if this adaptation comes from a temporary activation.
void	toHtmlString(Writer aWriter) For debugging purpose, adds an HTML representation to the writer specified.
String	toPublicReference() Returns a string that identifies this object from the user's point of view.
String	toString()
String	toXPathExpression() For an occurrence, this method returns the XPath expression that selects it in the instance.
String	toXPathPredicateString() For an occurrence, this method returns the XPath predicate that selects it in its table.

Methods inherited from class com.onwbp.adaptation.ReadContext

formatValue, formatValue, formatValues, get_boolean, get_int, get, getDate, getDescription, getLabel, getList, getLocale, getNomenclatureItemLabel, getResourcePathInModule, getResourcePathWithModule, getString, getTable, isEndUserDebug

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getContainerTable

public AdaptationTable getContainerTable()

If this is an occurrence, returns the table that contains it; returns null if this is an instance.

getContainer

public Adaptation getContainer()

If this adaptation is a table occurrence, returns the instance that contains it; returns null if this adaptation is an instance.

getAdaptationName

public AdaptationName getAdaptationName()

Returns the name that uniquely identifies this adaptation in the repository.

getTreeReference

public AdaptationReference getTreeReference()

Returns the name that uniquely identifies the tree of this adaptation in the repository. All the instances in a tree share the same reference and it is the reference of the root instance.

If this adaptatiion is an occurrence, then the returned reference is the one of its container instance tree.

getHome

public AdaptationHome getHome()

Returns the home which contains this instance.

getLabel

public String getLabel(Locale aLocale)

Returns the instance label corresponding to the given locale.

Returns null if no label exists for the locale.

getLabelOrName

public String getLabelOrName(Locale aLocale)

Returns the instance label corresponding to the given locale.

Returns the instance reference if no label exists for the locale.

getDescription

public String getDescription(Locale aLocale)

Returns the descption corresponding to the given locale.

Returns null if no description exists for the locale.

getDistributor

public Profile getDistributor()

Returns the distributor of this adaptation, null if it is not an agreement or under an agreement.

The distributor profile is defined only in the context of an agreement.

See Also:

getProvider()

getDistributorName

public com.onwbp.core.org.OrganizationName getDistributorName()

Deprecated.

See Also:

getDistributor()

getModuleName

public String getModuleName()

Returns the name of the module that holds the schema document.

See Also:

getSchemaLocation(), SchemaLocation.getModuleName()

getSchemaLocation

public SchemaLocation getSchemaLocation()

Returns the location of the schema document.

getValueWithoutResolution

public Object getValueWithoutResolution(Path aPath)

Returns the own value hold by the node specified. There are four possibilities:

1. If actual value is inherited, it returns AdaptationValue.INHERIT_VALUE.
2. If actual value is not inherited and not null, it returns the object defined (it must be an instance of the node's type).
3. If actual value is set to null (not inherited), it returns null.
4. If node specified does not exist, it returns AdaptationValue.INHERIT_VALUE.

Parameters:

aPath - location of the node. Only an absolute path is supported and it must specify a terminal node. If this adaptation is a table occurrence, path begins at the root of the occurrence.

See Also:

ReadContext.get(Path)

getProvider

public Profile getProvider()

Returns the owner of this adaptation.

See Also:

getDistributor()

getProviderName

public com.onwbp.core.org.OrganizationName getProviderName()

Deprecated.

See Also:

getProvider()

getUpToDateInstance

public Adaptation getUpToDateInstance()

Returns null if this instance has been deleted.

This method has the same result as ada.getHome().findAdaptationOrNull(ada.getAdaptationName()).

getUrlResourceRelative

public String getUrlResourceRelative(Path aPath)

Deprecated.

Replaced by method getResourcePathWithModule().

isActivated

public boolean isActivated()

Returns true if this adaptation is activated.

This state impacts the validation:

• inactivated: the inactivated state means that the adaptation validation will accept undefined values on "mandatory" elements (elements with minOccurs="1" in XML Schema). This feature allows to use an adaptation for internal EBX.Platform inheritance (on the one hand, it holds common values that will be inherited by adaptation children, on the other hand, other values usually remain undefined).
  
  It also implies that an inactivated adaptation should not be exported to external systems or used by them, since it can be "incomplete".
• activated: the activated state means that the adaptation is fully validated, by checking that "mandatory" elements are all present. An activated adaptation can be used safely by external systems, as soon as its validation is satisfactory.

See Also:

getValidationReport(boolean)

isAgreement

public boolean isAgreement()

Returns true if this adaptation is an agreement between the provider and a distributor, false otherwise.

isAgreementDescendant

public boolean isAgreementDescendant()

Returns true if this adaptation has an agreement in its ancestors, false otherwise. An agreement itself returns false

isDeleted

public boolean isDeleted()

Returns true if this adaptation has been deleted. In this case it is also considered as obsolete.

See Also:

isObsolete()

isObsolete

public boolean isObsolete()

Deprecated. Replaced by the method isDeleted().

isSchemaInstance

public boolean isSchemaInstance()

Returns true if this adaptation is a schema instance, not a table occurrence.

This is the opposite of isTableOccurrence().

isTableOccurrence

public boolean isTableOccurrence()

Returns true if this adaptation is a table occurrence, not a schema instance.

This is the opposite of isSchemaInstance().

isNewOrModifiedInCurrentBranch

public boolean isNewOrModifiedInCurrentBranch()

Returns true if we are in a branch and, regarding the initial version of this branch, this adaptation is newly created or it has been updated. It returns false if either the current home is a version or if this instance has not been modified since the initial version of the branch.

Note: the modification criterium does not include the modification on inherited values, inherited occurrences and inherited structure. For a schema instance, it does not include modifications on its tables.

See Also:

getTimeOfLastModification()

isEditionOfRelease

public boolean isEditionOfRelease()

Deprecated. Replaced by the method isNewOrModifiedInCurrentBranch().

isRelease

public boolean isRelease()

Deprecated. Replaced by the opposite result of method isNewOrModifiedInCurrentBranch().

isRootAdaptation

public boolean isRootAdaptation()

Returns true if this adaptation is root (it has no parent adaptation).

If this adaptation is a table occurrence, the method always returns false.

isTemporaryActivation

public boolean isTemporaryActivation()

Tests if this adaptation comes from a temporary activation.

A temporary activation is created by EBX.Manager, for preview or test purpose.

toHtmlString

public void toHtmlString(Writer aWriter)

Description copied from class: ReadContext

For debugging purpose, adds an HTML representation to the writer specified. The table displays hierarchically the values in this context.

Specified by:

toHtmlString in class ReadContext

toString

public String toString()

toPublicReference

public String toPublicReference()

Returns a string that identifies this object from the user's point of view.

See Also:

getAdaptationName()

getSchemaNode

public SchemaNode getSchemaNode()

Returns the root schema node of this adaptation.

getTimeOfCreation

public Date getTimeOfCreation()

Returns the time of the creation of this adaptation.

getTimeOfLastModification

public Date getTimeOfLastModification()

Returns the time of the last modification of this adaptation.

Current limitation: if this adaptation is a schema instance, not an occurrence, the time returned does not take into account modifications done on contained table occurrences (instance time is updated only for local content's modifications).

See Also:

getLastUser(), isNewOrModifiedInCurrentBranch()

getLastUser

public UserReference getLastUser()

Returns the last user who has modified the adaptation.

Current limitation: if this adaptation is a schema instance, not an occurrence, the last user is the user that has modified instance content locally (if another user has made an update more recently inside a table, this is not taken into account).

See Also:

getTimeOfLastModification()

getOccurrencePrimaryKey

public PrimaryKey getOccurrencePrimaryKey()

Returns the primary key of this occurrence.

If this adaptation is a schema instance, not an occurrence, the method returns null.

getOccurrenceDefinitionMode

public DefinitionMode getOccurrenceDefinitionMode()

Returns the definition mode of this occurrence.

If this adaptation is a schema instance, not an occurrence, the method returns null.

toXPathExpression

public String toXPathExpression()

For an occurrence, this method returns the XPath expression that selects it in the instance.

Example :

/root/categoryX/tableY[pkey1="A01" and pkey2="666"]

If this adaptation is a schema instance, not an occurrence, the method always returns "/" (root path).

See Also:

AdaptationTable.createRequestResult(String)

toXPathPredicateString

public String toXPathPredicateString()

For an occurrence, this method returns the XPath predicate that selects it in its table.

Example :

pkey1="A01" and pkey2="666"

If this adaptation is a schema instance, not an occurrence, the method always returns null.

See Also:

toXPathExpression()

isOccurrenceInheriting

public boolean isOccurrenceInheriting()

Returns true if this adaptation is a table ocurrence in inherit mode.

If this adaptation is a schema instance, not an occurrence, the method always returns false.

isOccurrenceOcculting

public boolean isOccurrenceOcculting()

Returns true if this adaptation is a table ocurrence in occulting mode.

If this adaptation is a schema instance, not an occurrence, the method always returns false.

isOccurrenceHidden

public boolean isOccurrenceHidden()

Returns true if this adaptation is a table occurrence that is in occulting mode or in edition-delete state.

If this adaptation is a schema instance, not an occurrence, the method always returns false.

isSchemaDefinitionCompliant

public boolean isSchemaDefinitionCompliant(boolean ensureActivation)

Returns true if the validation of this instance is correct regarding its schema definition.

Important note: After this method has been called for ensuring correctness, concurrent updates can occur. The rules for ensuring that Master Data remain valid are explained in section Consistency and validation.

Parameters:

ensureActivation - If true, validation also checks that this instance is activated. If false, it is not checked that instance is activated; this later value is normally used for internal EBX.Platform instances used for factoring data in an inheritance tree.

Throws:

IllegalStateException - If this adaptation is a table occurrence.

See Also:

getValidationReport()

getValidationReport

public ValidationReport getValidationReport()

Returns the validation status of this instance regarding its schema definition. The validation checks also that this instance is activated.

The validation is implicitly launched through this method so as to have an up-to-date report.

Important note: The report returned by this method is not mutable in the sense that it will not be affected by updates done after this method is called. The rules for ensuring that Master Data remain valid (regarding possible concurrent updates) are explained in section Consistency and validation.

This method is equivalent to:

Adaptation.getValidationReport(true);

Throws:

IllegalStateException - If this adaptation is a table occurrence.

See Also:

isSchemaDefinitionCompliant(boolean)

getValidationReport

public ValidationReport getValidationReport(boolean ensureActivation)

Returns the validation status of this instance regarding its schema definition.

The validation is implicitly launched through this method so as to have an up-to-date report.

Important note: The report returned by this method is not mutable in the sense that it will not be affected by updates done after this method is called. The rules for ensuring that Master Data remain valid (regarding possible concurrent updates) are explained in section Consistency and validation.

Parameters:

ensureActivation - If true, validation also checks that this instance is activated. If false, it is not checked that instance is activated; this later value is normally used for internal EBX.Platform instances used for factoring data in an inheritance tree.

Throws:

IllegalStateException - If this adaptation is a table occurrence.

See Also:

isSchemaDefinitionCompliant(boolean), AdaptationHome.getValidationReportsMap(Severity)

checkActivable

public ActivationStatus checkActivable()

Deprecated. This method has been replaced by getValidationReport().

getAdaptationNode

public AdaptationNode getAdaptationNode(Path aPath)
                                 throws PathAccessException

Deprecated. Replaced by getSchemaNode().

Returns the node specified.

Throws:

PathAccessException - if aPath does not refer to an adaptable node in the underlying type tree structure.