Class AdaptationHome
- java.lang.Object
-
- com.onwbp.adaptation.AdaptationHome
-
public abstract class AdaptationHome extends Object
Represents a dataspace or a snapshot in a repository.Note: In previous versions, a dataspace was known as a branch, and a snapshot was known as a version.
- See Also:
Repository
-
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description Adaptation
findAdaptationOrNull(AdaptationName aName)
Returns the specified dataset or record based on itsAdaptationName
.abstract List<Adaptation>
findAllChildren(Adaptation aDataSetOrRecord)
Returns a list of all datasets or records that are direct children of the one specified.abstract List<Adaptation>
findAllDescendants(Adaptation aDataSetOrRecord)
Returns a list of all the datasets and records that inherit from the one specified, either as direct children or as descendants (recursive).abstract List<Adaptation>
findAllRoots()
Returns all the dataset roots of thisAdaptationHome
.Adaptation
findParent(Adaptation aDataSetOrRecord)
Deprecated.Replaced byAdaptation.getParent()
.abstract List<AdaptationHome>
getBranchChildren()
Returns the dataspaces which have been created from thisAdaptationHome
.abstract Date
getCreationDate()
Returns the creation date of this dataspace or snapshot.abstract Profile
getCreator()
Returns the creator profile of this dataspace or snapshot in the current repository.abstract UserMessage
getDescription()
Returns the internationalized description of this dataspace or snapshot.abstract String
getDescription(Locale aLocale)
Returns the description of this dataspace or snapshot for a given locale.HomeKey
getKey()
Returns the key that identifies this dataspace or snapshot in the current repository.abstract UserMessage
getLabel()
Returns the internationalized label of this dataspace or snapshot.abstract String
getLabel(Locale aLocale)
Returns the label of this dataspace or snapshot for a given locale.abstract String
getLabelOrName(Locale aLocale)
Returns the label of this dataspace or snapshot for a given locale.abstract UserMessage
getLabelOrNameAsUserMessage()
Returns the internationalized label of this dataspace or snapshot.abstract Profile
getOwner()
Returns the owner profile of this dataspace or snapshot in the current repository.abstract AdaptationHome
getParent()
Returns the parent dataspace of thisAdaptationHome
.abstract AdaptationHome
getParentBranch()
Returns the parent dataspace or snapshot of thisAdaptationHome
.abstract Repository
getRepository()
Returns the repository that contains thisAdaptationHome
.abstract Date
getTerminationDate()
Returns the date this dataspace or snapshot was closed, if it is closed.abstract DataspaceValidationReport
getValidationReport(Severity minimalSeverity)
Returns all validation reports for datasets in thisAdaptationHome
that have at least one validation item of the specified severity or higher.abstract DataspaceValidationReport
getValidationReport(ValidationSpec aValidationSpec)
Returns the validation report for this dataspace according to the specified properties.abstract Map<AdaptationName,ValidationReport>
getValidationReportsMap(Severity minimalSeverity)
Deprecated.Replaced bygetValidationReport(Severity)
.abstract List<AdaptationHome>
getVersionChildren()
Returns the snapshots which have been created from thisAdaptationHome
.boolean
isAncestorOf(AdaptationHome anotherHome)
Returnstrue
if thisAdaptationHome
is an ancestor of the specifiedAdaptationHome
(theAdaptationHome
itself is excluded).boolean
isBranch()
Returnstrue
if thisAdaptationHome
is a dataspace.boolean
isBranchReference()
boolean
isInitialVersion()
Returnstrue
if thisAdaptationHome
is an initial snapshot of a dataspace.abstract boolean
isLockedBranch()
Returnstrue
if thisAdaptationHome
is a locked dataspace.abstract boolean
isMarkedForHistoryPurge()
Returnstrue
if thisAdaptationHome
is marked for history purge.boolean
isMarkedForPurge()
Deprecated.abstract boolean
isOpen()
Returnstrue
if thisAdaptationHome
is either an open snapshot or an open dataspace.boolean
isOpenBranch()
Returnstrue
if thisAdaptationHome
is an open dataspace.boolean
isOpenVersion()
Returnstrue
if thisAdaptationHome
is an open snapshot.boolean
isTechnicalBranch()
Returnstrue
if thisAdaptationHome
is a technical dataspace.boolean
isTechnicalVersion()
Returnstrue
if thisAdaptationHome
is a technical snapshot.abstract boolean
isUsedByValidation()
Checks whether the current instance ofAdaptationHome
is a dedicated validation dataspace.boolean
isVersion()
Returnstrue
if thisAdaptationHome
is a snapshot.void
resetValidationReports()
Resets the validation reports of the datasets contained in this dataspace.String
toDisplayString(Locale aLocale)
Returns a user-friendly string that specifies the type of this object, for example, "Dataspace <key>" or "Snapshot <key>".
-
-
-
Method Detail
-
findAdaptationOrNull
public final Adaptation findAdaptationOrNull(AdaptationName aName)
Returns the specified dataset or record based on itsAdaptationName
. Returnsnull
if it cannot be found.- See Also:
AdaptationName
-
findParent
@Deprecated public final Adaptation findParent(Adaptation aDataSetOrRecord)
Deprecated.Replaced byAdaptation.getParent()
.
-
findAllChildren
public abstract List<Adaptation> findAllChildren(Adaptation aDataSetOrRecord)
Returns a list of all datasets or records that are direct children of the one specified.
-
findAllDescendants
public abstract List<Adaptation> findAllDescendants(Adaptation aDataSetOrRecord)
Returns a list of all the datasets and records that inherit from the one specified, either as direct children or as descendants (recursive).
-
findAllRoots
public abstract List<Adaptation> findAllRoots()
Returns all the dataset roots of thisAdaptationHome
.- See Also:
Adaptation.isRootAdaptation()
-
getKey
public final HomeKey getKey()
Returns the key that identifies this dataspace or snapshot in the current repository.
-
getOwner
public abstract Profile getOwner()
Returns the owner profile of this dataspace or snapshot in the current repository.
-
getCreator
public abstract Profile getCreator()
Returns the creator profile of this dataspace or snapshot in the current repository.Returns
null
if no creator is defined. For example, technical reserved branches are created by the 'System User'.
-
getLabel
public abstract UserMessage getLabel()
Returns the internationalized label of this dataspace or snapshot.Returns
null
if no labels are defined in any language.
-
getLabel
public abstract String getLabel(Locale aLocale)
Returns the label of this dataspace or snapshot for a given locale. Returnsnull
if no label is defined for the locale provided.
-
getLabelOrName
public abstract String getLabelOrName(Locale aLocale)
Returns the label of this dataspace or snapshot for a given locale. Returns the key name if no label is defined for the locale provided.
-
getLabelOrNameAsUserMessage
public abstract UserMessage getLabelOrNameAsUserMessage()
Returns the internationalized label of this dataspace or snapshot. Returns the key name if no labels are defined in any locale.
-
getDescription
public abstract UserMessage getDescription()
Returns the internationalized description of this dataspace or snapshot.Returns
null
if no descriptions are defined in any language.
-
getDescription
public abstract String getDescription(Locale aLocale)
Returns the description of this dataspace or snapshot for a given locale. Returnsnull
if no description is defined for the locale provided.
-
getCreationDate
public abstract Date getCreationDate()
Returns the creation date of this dataspace or snapshot.
-
getTerminationDate
public abstract Date getTerminationDate()
Returns the date this dataspace or snapshot was closed, if it is closed.Returns
null
if the dataspace or snapshot is open.
-
getParent
public abstract AdaptationHome getParent()
Returns the parent dataspace of thisAdaptationHome
. Returnsnull
if this is thereference dataspace
.For a dataspace, its parent is always its initial snapshot. For a snapshot, its parent is always its parent dataspace.
-
getParentBranch
public abstract AdaptationHome getParentBranch()
Returns the parent dataspace or snapshot of thisAdaptationHome
. Returnsnull
if thisAdaptationHome
is thereference dataspace
.Note: For a dataspace, its direct parent is its initial snapshot, hence its parent dataspace is the parent of this initial snapshot. For a snapshot, its parent dataspace is its direct parent.
- See Also:
getBranchChildren()
,getVersionChildren()
-
getBranchChildren
public abstract List<AdaptationHome> getBranchChildren()
Returns the dataspaces which have been created from thisAdaptationHome
.Note: A dataspace has no direct dataspace children; when a dataspace is created from another dataspace, first an initial snapshot is created, then the new dataspace is created from this initial snapshot.
- See Also:
getVersionChildren()
-
getVersionChildren
public abstract List<AdaptationHome> getVersionChildren()
Returns the snapshots which have been created from thisAdaptationHome
.A snapshot is always created from a dataspace.
- See Also:
getBranchChildren()
-
getRepository
public abstract Repository getRepository()
Returns the repository that contains thisAdaptationHome
.
-
isBranch
public final boolean isBranch()
Returnstrue
if thisAdaptationHome
is a dataspace.
-
isBranchReference
public final boolean isBranchReference()
-
isOpenBranch
public final boolean isOpenBranch()
Returnstrue
if thisAdaptationHome
is an open dataspace.
-
isOpenVersion
public final boolean isOpenVersion()
Returnstrue
if thisAdaptationHome
is an open snapshot.
-
isOpen
public abstract boolean isOpen()
Returnstrue
if thisAdaptationHome
is either an open snapshot or an open dataspace.
-
isLockedBranch
public abstract boolean isLockedBranch()
Returnstrue
if thisAdaptationHome
is a locked dataspace.- See Also:
LockSpec
-
isMarkedForPurge
@Deprecated public final boolean isMarkedForPurge()
Deprecated.Always returnsfalse
.
-
isMarkedForHistoryPurge
public abstract boolean isMarkedForHistoryPurge()
Returnstrue
if thisAdaptationHome
is marked for history purge.
-
isAncestorOf
public final boolean isAncestorOf(AdaptationHome anotherHome)
Returnstrue
if thisAdaptationHome
is an ancestor of the specifiedAdaptationHome
(theAdaptationHome
itself is excluded).
-
isVersion
public final boolean isVersion()
Returnstrue
if thisAdaptationHome
is a snapshot.
-
isInitialVersion
public final boolean isInitialVersion()
Returnstrue
if thisAdaptationHome
is an initial snapshot of a dataspace.When a dataspace is created from another dataspace, first an initial snapshot is created, then the new dataspace is created from this initial snapshot.
- See Also:
Repository
-
toDisplayString
public final String toDisplayString(Locale aLocale)
Returns a user-friendly string that specifies the type of this object, for example, "Dataspace <key>" or "Snapshot <key>".- See Also:
getKey()
-
getValidationReportsMap
@Deprecated public abstract Map<AdaptationName,ValidationReport> getValidationReportsMap(Severity minimalSeverity)
Deprecated.Replaced bygetValidationReport(Severity)
.
-
getValidationReport
public abstract DataspaceValidationReport getValidationReport(ValidationSpec aValidationSpec)
Returns the validation report for this dataspace according to the specified properties. Warning: all datasets in the dataspace are validated according to the specified policy. This process can be time consuming.- Since:
- 6.1.1
- See Also:
getValidationReport(Severity)
,getValidationReportsMap(Severity)
,ValidationSpec
-
getValidationReport
public abstract DataspaceValidationReport getValidationReport(Severity minimalSeverity)
Returns all validation reports for datasets in thisAdaptationHome
that have at least one validation item of the specified severity or higher.Since this method calls
Adaptation.getValidationReport(false)
on each dataset, it does not require the datasets to be activated.The rules for ensuring that data in EBX® remains valid, with respect to potential concurrent updates, are explained in the Consistency and validation section.
- Returns:
DataspaceValidationReportImpl
- Since:
- 6.1.1
- See Also:
ValidationReport.hasItemsOfSeverityOrMore(Severity)
-
resetValidationReports
public final void resetValidationReports()
Resets the validation reports of the datasets contained in this dataspace.- Since:
- 5.9.0
- See Also:
Adaptation.resetValidationReport(boolean)
,getValidationReportsMap(Severity)
-
isTechnicalBranch
public final boolean isTechnicalBranch()
Returnstrue
if thisAdaptationHome
is a technical dataspace. A technical dataspace is used internally used by EBX®, and cannot be closed or merged.
-
isUsedByValidation
public abstract boolean isUsedByValidation()
Checks whether the current instance ofAdaptationHome
is a dedicated validation dataspace. It returnstrue
if this dataspace:- Contains persisted validation reports.
- Is used to validate data.
- Since:
- 6.1.1
-
isTechnicalVersion
public final boolean isTechnicalVersion()
Returnstrue
if thisAdaptationHome
is a technical snapshot. A snapshot is technical if it is a snapshot of a technical dataspace.- See Also:
isTechnicalBranch()
-
-