http://git-wip-us.apache.org/repos/asf/atlas/blob/a1fd4068/omrs/src/main/java/org/apache/atlas/omrs/localrepository/repositorycontentmanager/OMRSRepositoryHelper.java
----------------------------------------------------------------------
diff --git
a/omrs/src/main/java/org/apache/atlas/omrs/localrepository/repositorycontentmanager/OMRSRepositoryHelper.java
b/omrs/src/main/java/org/apache/atlas/omrs/localrepository/repositorycontentmanager/OMRSRepositoryHelper.java
index bd7fcbd..911c203 100644
---
a/omrs/src/main/java/org/apache/atlas/omrs/localrepository/repositorycontentmanager/OMRSRepositoryHelper.java
+++
b/omrs/src/main/java/org/apache/atlas/omrs/localrepository/repositorycontentmanager/OMRSRepositoryHelper.java
@@ -19,19 +19,11 @@ package
org.apache.atlas.omrs.localrepository.repositorycontentmanager;
import org.apache.atlas.omrs.ffdc.OMRSErrorCode;
-import org.apache.atlas.omrs.ffdc.exception.OMRSLogicErrorException;
-import org.apache.atlas.omrs.ffdc.exception.PatchErrorException;
+import org.apache.atlas.omrs.ffdc.exception.*;
import org.apache.atlas.omrs.metadatacollection.properties.instances.*;
-import
org.apache.atlas.omrs.metadatacollection.properties.typedefs.AttributeTypeDef;
-import org.apache.atlas.omrs.metadatacollection.properties.typedefs.TypeDef;
-import
org.apache.atlas.omrs.metadatacollection.properties.typedefs.TypeDefCategory;
-import
org.apache.atlas.omrs.metadatacollection.properties.typedefs.TypeDefPatch;
+import org.apache.atlas.omrs.metadatacollection.properties.typedefs.*;
-import org.apache.atlas.omrs.ffdc.exception.TypeErrorException;
-
-import java.util.ArrayList;
-import java.util.Date;
-import java.util.UUID;
+import java.util.*;
/**
* OMRSRepositoryHelper provides methods to repository connectors and
repository event mappers to help
@@ -42,10 +34,13 @@ import java.util.UUID;
*/
public class OMRSRepositoryHelper implements OMRSTypeDefHelper,
OMRSInstanceHelper
{
- private static OMRSRepositoryContentManager repositoryContentManager =
null;
+ private static OMRSRepositoryContentManager
defaultRepositoryContentManager = null;
+
+ private OMRSRepositoryContentManager repositoryContentManager;
+
/**
- * Set up the local repository's content manager. This maintains a cache
of the local repository's type
+ * Set up the default local repository's content manager. This maintains
a cache of the local repository's type
* definitions and rules to provide helpers and validators for TypeDefs
and instances that are
* exchanged amongst the open metadata repositories and open metadata
access services (OMAS).
*
@@ -53,7 +48,29 @@ public class OMRSRepositoryHelper implements
OMRSTypeDefHelper, OMRSInstanceHelp
*/
public static synchronized void
setRepositoryContentManager(OMRSRepositoryContentManager
repositoryContentManager)
{
- OMRSRepositoryHelper.repositoryContentManager =
repositoryContentManager;
+ OMRSRepositoryHelper.defaultRepositoryContentManager =
repositoryContentManager;
+ }
+
+
+ /**
+ * Default constructor uses the default repository content manager.
Repository connectors should use the
+ * repository helper from their superclass.
+ */
+ @Deprecated
+ public OMRSRepositoryHelper()
+ {
+ this.repositoryContentManager = defaultRepositoryContentManager;
+ }
+
+
+ /**
+ * Creates a repository helper linked to the supplied repository content
manager.
+ *
+ * @param repositoryContentManager - object associated with the local
repository.
+ */
+ public OMRSRepositoryHelper(OMRSRepositoryContentManager
repositoryContentManager)
+ {
+ this.repositoryContentManager = repositoryContentManager;
}
@@ -63,6 +80,68 @@ public class OMRSRepositoryHelper implements
OMRSTypeDefHelper, OMRSInstanceHelp
*/
/**
+ * Return the list of typedefs active in the local repository.
+ *
+ * @return TypeDef gallery
+ */
+ public TypeDefGallery getActiveTypeDefGallery()
+ {
+ final String methodName = "getActiveTypeDefGallery()";
+
+ if (repositoryContentManager != null)
+ {
+ /*
+ * Delegate call to repository content manager.
+ */
+ return repositoryContentManager.getActiveTypeDefGallery();
+ }
+ else
+ {
+ OMRSErrorCode errorCode =
OMRSErrorCode.LOCAL_REPOSITORY_CONFIGURATION_ERROR;
+ String errorMessage = errorCode.getErrorMessageId() +
errorCode.getFormattedErrorMessage();
+
+ throw new OMRSLogicErrorException(errorCode.getHTTPErrorCode(),
+ this.getClass().getName(),
+ methodName,
+ errorMessage,
+ errorCode.getSystemAction(),
+ errorCode.getUserAction());
+ }
+ }
+
+
+ /**
+ * Return the list of typedefs known by the local repository.
+ *
+ * @return TypeDef gallery
+ */
+ public TypeDefGallery getKnownTypeDefGallery()
+ {
+ final String methodName = "getKnownTypeDefGallery()";
+
+ if (repositoryContentManager != null)
+ {
+ /*
+ * Delegate call to repository content manager.
+ */
+ return repositoryContentManager.getKnownTypeDefGallery();
+ }
+ else
+ {
+ OMRSErrorCode errorCode =
OMRSErrorCode.LOCAL_REPOSITORY_CONFIGURATION_ERROR;
+ String errorMessage = errorCode.getErrorMessageId() +
errorCode.getFormattedErrorMessage();
+
+ throw new OMRSLogicErrorException(errorCode.getHTTPErrorCode(),
+ this.getClass().getName(),
+ methodName,
+ errorMessage,
+ errorCode.getSystemAction(),
+ errorCode.getUserAction());
+ }
+ }
+
+
+ /**
* Return the TypeDef identified by the name supplied by the caller. This
is used in the connectors when
* validating the actual types of the repository with the known open
metadata types - looking specifically
* for types of the same name but with different content.
@@ -86,8 +165,7 @@ public class OMRSRepositoryHelper implements
OMRSTypeDefHelper, OMRSInstanceHelp
else
{
OMRSErrorCode errorCode =
OMRSErrorCode.LOCAL_REPOSITORY_CONFIGURATION_ERROR;
- String errorMessage = errorCode.getErrorMessageId()
- + errorCode.getFormattedErrorMessage();
+ String errorMessage = errorCode.getErrorMessageId() +
errorCode.getFormattedErrorMessage();
throw new OMRSLogicErrorException(errorCode.getHTTPErrorCode(),
this.getClass().getName(),
@@ -123,8 +201,114 @@ public class OMRSRepositoryHelper implements
OMRSTypeDefHelper, OMRSInstanceHelp
else
{
OMRSErrorCode errorCode =
OMRSErrorCode.LOCAL_REPOSITORY_CONFIGURATION_ERROR;
- String errorMessage = errorCode.getErrorMessageId()
- + errorCode.getFormattedErrorMessage();
+ String errorMessage = errorCode.getErrorMessageId() +
errorCode.getFormattedErrorMessage();
+
+ throw new OMRSLogicErrorException(errorCode.getHTTPErrorCode(),
+ this.getClass().getName(),
+ methodName,
+ errorMessage,
+ errorCode.getSystemAction(),
+ errorCode.getUserAction());
+ }
+ }
+
+
+ /**
+ * Return the TypeDefs identified by the name supplied by the caller. The
TypeDef name may have wild
+ * card characters in it such as * and & which is why the results are
returned in a list.
+ *
+ * @param sourceName - source of the request (used for logging)
+ * @param typeDefName - unique name for the TypeDef
+ * @return TypeDef object or null if TypeDef is not known.
+ */
+ public TypeDefGallery getActiveTypesByWildCardName (String sourceName,
+ String
typeDefName)
+ {
+ final String methodName = "getActiveTypesByWildCardName()";
+
+ if (repositoryContentManager != null)
+ {
+ /*
+ * Delegate call to repository content manager.
+ */
+ return
repositoryContentManager.getActiveTypesByWildCardName(sourceName, typeDefName);
+ }
+ else
+ {
+ OMRSErrorCode errorCode =
OMRSErrorCode.LOCAL_REPOSITORY_CONFIGURATION_ERROR;
+ String errorMessage = errorCode.getErrorMessageId() +
errorCode.getFormattedErrorMessage();
+
+ throw new OMRSLogicErrorException(errorCode.getHTTPErrorCode(),
+ this.getClass().getName(),
+ methodName,
+ errorMessage,
+ errorCode.getSystemAction(),
+ errorCode.getUserAction());
+ }
+ }
+
+
+ /**
+ * Return the TypeDef identified by the guid supplied by the caller. This
call is used when
+ * retrieving a type that only the guid is known.
+ *
+ * @param sourceName - source of the request (used for logging)
+ * @param typeDefGUID - unique identifier for the TypeDef
+ * @return TypeDef object
+ * @throws TypeErrorException - unknown or invalid type
+ */
+ public TypeDef getTypeDef (String sourceName,
+ String typeDefGUID) throws
TypeErrorException
+ {
+ final String methodName = "getTypeDef()";
+
+ if (repositoryContentManager != null)
+ {
+ /*
+ * Delegate call to repository content manager.
+ */
+ return repositoryContentManager.getTypeDef(sourceName,
typeDefGUID);
+ }
+ else
+ {
+ OMRSErrorCode errorCode =
OMRSErrorCode.LOCAL_REPOSITORY_CONFIGURATION_ERROR;
+ String errorMessage = errorCode.getErrorMessageId() +
errorCode.getFormattedErrorMessage();
+
+ throw new OMRSLogicErrorException(errorCode.getHTTPErrorCode(),
+ this.getClass().getName(),
+ methodName,
+ errorMessage,
+ errorCode.getSystemAction(),
+ errorCode.getUserAction());
+ }
+ }
+
+
+ /**
+ * Return the AttributeTypeDef identified by the guid and name supplied by
the caller. This call is used when
+ * retrieving a type that only the guid is known.
+ *
+ * @param sourceName - source of the request (used for logging)
+ * @param attributeTypeDefGUID - unique identifier for the AttributeTypeDef
+ * @return TypeDef object
+ * @throws TypeErrorException - unknown or invalid type
+ */
+ public AttributeTypeDef getAttributeTypeDef (String sourceName,
+ String
attributeTypeDefGUID) throws TypeErrorException
+ {
+ final String methodName = "getAttributeTypeDef()";
+
+ if (repositoryContentManager != null)
+ {
+ /*
+ * Delegate call to repository content manager.
+ */
+ return repositoryContentManager.getAttributeTypeDef(sourceName,
attributeTypeDefGUID);
+ }
+ else
+ {
+ OMRSErrorCode errorCode =
OMRSErrorCode.LOCAL_REPOSITORY_CONFIGURATION_ERROR;
+ String errorMessage = errorCode.getErrorMessageId() +
errorCode.getFormattedErrorMessage();
throw new OMRSLogicErrorException(errorCode.getHTTPErrorCode(),
this.getClass().getName(),
@@ -162,8 +346,7 @@ public class OMRSRepositoryHelper implements
OMRSTypeDefHelper, OMRSInstanceHelp
else
{
OMRSErrorCode errorCode =
OMRSErrorCode.LOCAL_REPOSITORY_CONFIGURATION_ERROR;
- String errorMessage = errorCode.getErrorMessageId()
- + errorCode.getFormattedErrorMessage();
+ String errorMessage = errorCode.getErrorMessageId() +
errorCode.getFormattedErrorMessage();
throw new OMRSLogicErrorException(errorCode.getHTTPErrorCode(),
this.getClass().getName(),
@@ -202,8 +385,7 @@ public class OMRSRepositoryHelper implements
OMRSTypeDefHelper, OMRSInstanceHelp
else
{
OMRSErrorCode errorCode =
OMRSErrorCode.LOCAL_REPOSITORY_CONFIGURATION_ERROR;
- String errorMessage = errorCode.getErrorMessageId()
- + errorCode.getFormattedErrorMessage();
+ String errorMessage = errorCode.getErrorMessageId() +
errorCode.getFormattedErrorMessage();
throw new OMRSLogicErrorException(errorCode.getHTTPErrorCode(),
this.getClass().getName(),
@@ -220,38 +402,367 @@ public class OMRSRepositoryHelper implements
OMRSTypeDefHelper, OMRSInstanceHelp
* the patch is incompatible with the original TypeDef. For example, if
there is a mismatch between
* the type or version that either represents.
*
- * @param sourceName - source of the request (used for logging)
+ * @param sourceName - source of the TypeDef (used for logging)
* @param typeDefPatch - patch to apply
+ * @param originalTypeDef - typeDef to patch
* @return updated TypeDef
* @throws PatchErrorException - the patch is either badly formatted, or
does not apply to the supplied TypeDef
+ * @throws InvalidParameterException - the TypeDefPatch is null.
*/
- public TypeDef applyPatch(String sourceName, TypeDefPatch typeDefPatch)
throws PatchErrorException
+ public TypeDef applyPatch(String sourceName,
+ TypeDef originalTypeDef,
+ TypeDefPatch typeDefPatch) throws
PatchErrorException,
+
InvalidParameterException
{
- final String methodName = "applyPatch()";
- if (repositoryContentManager != null)
+ TypeDef clonedTypeDef = null;
+ TypeDef updatedTypeDef = null;
+
+ /*
+ * Begin with simple validation of the typeDef patch.
+ */
+ if (typeDefPatch != null)
{
- /*
- * Delegate call to repository content manager.
- */
- return repositoryContentManager.applyPatch(sourceName,
typeDefPatch);
+ // TODO invalid parameter exception
}
- else
+
+ long newVersion = typeDefPatch.getUpdateToVersion();
+ if (newVersion <= typeDefPatch.getApplyToVersion())
{
- OMRSErrorCode errorCode =
OMRSErrorCode.LOCAL_REPOSITORY_CONFIGURATION_ERROR;
- String errorMessage = errorCode.getErrorMessageId()
- + errorCode.getFormattedErrorMessage();
+ // TODO PatchError
+ }
- throw new OMRSLogicErrorException(errorCode.getHTTPErrorCode(),
- this.getClass().getName(),
- methodName,
- errorMessage,
- errorCode.getSystemAction(),
- errorCode.getUserAction());
+ TypeDefPatchAction patchAction = typeDefPatch.getAction();
+ if (patchAction == null)
+ {
+ // TODO patch error
}
+
+
+ /*
+ * Is the version compatible?
+ */
+ if (originalTypeDef.getVersion() != typeDefPatch.getApplyToVersion())
+ {
+ // TODO throw PatchException - incompatible versions
+ }
+
+ /*
+ * OK to perform the update. Need to create a new TypeDef object.
TypeDef is an abstract class
+ * so need to use the TypeDefCategory to create a new object of the
correct type.
+ */
+ TypeDefCategory category = originalTypeDef.getCategory();
+ if (category == null)
+ {
+ // TODO Throw PatchError - base type is messed up
+ }
+
+ try
+ {
+ switch (category)
+ {
+ case ENTITY_DEF:
+ clonedTypeDef = new EntityDef((EntityDef) originalTypeDef);
+ break;
+
+ case RELATIONSHIP_DEF:
+ clonedTypeDef = new RelationshipDef((RelationshipDef)
originalTypeDef);
+ break;
+
+ case CLASSIFICATION_DEF:
+ clonedTypeDef = new ClassificationDef((ClassificationDef)
originalTypeDef);
+ break;
+ }
+ }
+ catch (ClassCastException castError)
+ {
+ // TODO Throw PatchError - base type is messed up
+ }
+
+ /*
+ * Now we have a new TypeDef - just need to make the changes. The
Action
+ */
+ if (clonedTypeDef != null)
+ {
+ switch (patchAction)
+ {
+ case ADD_ATTRIBUTES:
+ updatedTypeDef =
this.patchTypeDefAttributes(clonedTypeDef, typeDefPatch.getTypeDefAttributes());
+ break;
+
+ case ADD_OPTIONS:
+ updatedTypeDef =
this.patchTypeDefNewOptions(clonedTypeDef, typeDefPatch.getTypeDefOptions());
+ break;
+
+ case UPDATE_OPTIONS:
+ updatedTypeDef =
this.patchTypeDefUpdateOptions(clonedTypeDef, typeDefPatch.getTypeDefOptions());
+ break;
+
+ case DELETE_OPTIONS:
+ updatedTypeDef =
this.patchTypeDefDeleteOptions(clonedTypeDef, typeDefPatch.getTypeDefOptions());
+ break;
+
+ case ADD_EXTERNAL_STANDARDS:
+ updatedTypeDef =
this.patchTypeDefAddExternalStandards(clonedTypeDef,
+
typeDefPatch.getExternalStandardMappings(),
+
typeDefPatch.getTypeDefAttributes());
+ break;
+
+ case UPDATE_EXTERNAL_STANDARDS:
+ updatedTypeDef =
this.patchTypeDefUpdateExternalStandards(clonedTypeDef,
+
typeDefPatch.getExternalStandardMappings(),
+
typeDefPatch.getTypeDefAttributes());
+ break;
+
+ case DELETE_EXTERNAL_STANDARDS:
+ updatedTypeDef =
this.patchTypeDefDeleteExternalStandards(clonedTypeDef,
+
typeDefPatch.getExternalStandardMappings(),
+
typeDefPatch.getTypeDefAttributes());
+ break;
+
+ case UPDATE_DESCRIPTIONS:
+ updatedTypeDef =
this.patchTypeDefNewDescriptions(clonedTypeDef,
+
typeDefPatch.getDescription(),
+
typeDefPatch.getDescriptionGUID(),
+
typeDefPatch.getTypeDefAttributes());
+ break;
+ }
+ }
+
+
+ if (updatedTypeDef != null)
+ {
+ updatedTypeDef.setVersion(typeDefPatch.getUpdateToVersion());
+ updatedTypeDef.setVersionName(typeDefPatch.getNewVersionName());
+ }
+
+ return updatedTypeDef;
+ }
+
+
+ /**
+ * Add the supplied attributes to the properties definition for the cloned
typedef.
+ *
+ * @param clonedTypeDef - TypeDef object to update
+ * @param typeDefAttributes - new attributes to add.
+ * @return updated TypeDef
+ * @throws PatchErrorException - problem adding attributes
+ */
+ private TypeDef patchTypeDefAttributes(TypeDef
clonedTypeDef,
+ List<TypeDefAttribute>
typeDefAttributes) throws PatchErrorException
+ {
+ List<TypeDefAttribute> propertyDefinitions =
clonedTypeDef.getPropertiesDefinition();
+
+ if (propertyDefinitions == null)
+ {
+ propertyDefinitions = new ArrayList<>();
+ }
+
+ for (TypeDefAttribute newAttribute : typeDefAttributes)
+ {
+ if (newAttribute != null)
+ {
+ String attributeName =
newAttribute.getAttributeName();
+ AttributeTypeDef attributeType =
newAttribute.getAttributeType();
+
+ if ((attributeName != null) && (attributeType != null))
+ {
+ if (propertyDefinitions.contains(newAttribute))
+ {
+ // TODO Patch error - Duplicate Attribute
+ }
+ else
+ {
+ propertyDefinitions.add(newAttribute);
+ }
+ }
+ else
+ {
+ // TODO Patch Error - Invalid Attribute in patch
+ }
+ }
+ }
+
+ if (propertyDefinitions.size() > 0)
+ {
+ clonedTypeDef.setPropertiesDefinition(propertyDefinitions);
+ }
+ else
+ {
+ clonedTypeDef.setPropertiesDefinition(null);
+ }
+
+ return clonedTypeDef;
+ }
+
+
+ /**
+ *
+ * @param clonedTypeDef - TypeDef object to update
+ * @param typeDefOptions - new options to add
+ * @return updated TypeDef
+ * @throws PatchErrorException - problem adding options
+ */
+ private TypeDef patchTypeDefNewOptions(TypeDef clonedTypeDef,
+ Map<String, String> typeDefOptions)
throws PatchErrorException
+ {
+ // TODO
+ return null;
+ }
+
+
+ /**
+ *
+ * @param clonedTypeDef - TypeDef object to update
+ * @param typeDefOptions - options to update
+ * @return updated TypeDef
+ * @throws PatchErrorException - problem updating options
+ */
+ private TypeDef patchTypeDefUpdateOptions(TypeDef
clonedTypeDef,
+ Map<String, String>
typeDefOptions) throws PatchErrorException
+ {
+ // TODO
+ return null;
+ }
+
+
+ /**
+ *
+ * @param clonedTypeDef - TypeDef object to update
+ * @param typeDefOptions - options to delete
+ * @return updated TypeDef
+ * @throws PatchErrorException - problem deleting options
+ */
+ private TypeDef patchTypeDefDeleteOptions(TypeDef
clonedTypeDef,
+ Map<String, String>
typeDefOptions) throws PatchErrorException
+ {
+ // TODO
+ return null;
+ }
+
+
+ /**
+ * Add new mappings to external standards to the TypeDef.
+ *
+ * @param clonedTypeDef - TypeDef object to update
+ * @param externalStandardMappings - new mappings to add
+ * @return updated TypeDef
+ * @throws PatchErrorException - problem adding mapping(s)
+ */
+ private TypeDef patchTypeDefAddExternalStandards(TypeDef
clonedTypeDef,
+
List<ExternalStandardMapping> externalStandardMappings,
+ List<TypeDefAttribute>
typeDefAttributes) throws PatchErrorException
+ {
+ // TODO
+ return null;
+ }
+
+
+ /**
+ * Update the supplied mappings from the TypeDef.
+ *
+ * @param clonedTypeDef - TypeDef object to update
+ * @param externalStandardMappings - mappings to update
+ * @return updated TypeDef
+ * @throws PatchErrorException - problem updating mapping(s)
+ */
+ private TypeDef patchTypeDefUpdateExternalStandards(TypeDef
clonedTypeDef,
+
List<ExternalStandardMapping> externalStandardMappings,
+ List<TypeDefAttribute>
typeDefAttributes) throws PatchErrorException
+ {
+ // TODO
+ return null;
+ }
+
+
+ /**
+ * Delete the supplied mappings from the TypeDef.
+ *
+ * @param clonedTypeDef - TypeDef object to update
+ * @param externalStandardMappings - list of mappings to delete
+ * @return updated TypeDef
+ * @throws PatchErrorException - problem deleting mapping(s)
+ */
+ private TypeDef patchTypeDefDeleteExternalStandards(TypeDef
clonedTypeDef,
+
List<ExternalStandardMapping> externalStandardMappings,
+ List<TypeDefAttribute>
typeDefAttributes) throws PatchErrorException
+ {
+ // TODO
+ return null;
}
+ /**
+ * Update the descriptions for the TypeDef or any of its attributes. If
the description values are null, they are
+ * not changes in the TypeDef. This means there is no way to clear a
description - just update it for a better one.
+ *
+ * @param clonedTypeDef - TypeDef object to update
+ * @param description - new description
+ * @param descriptionGUID - new unique identifier for glossary term that
provides detailed description of TypeDef
+ * @return updated TypeDef
+ * @throws PatchErrorException - problem adding new description
+ */
+ private TypeDef patchTypeDefNewDescriptions(TypeDef
clonedTypeDef,
+ String
description,
+ String
descriptionGUID,
+ List<TypeDefAttribute>
typeDefAttributes) throws PatchErrorException
+ {
+ if (description != null)
+ {
+ clonedTypeDef.setDescription(description);
+ }
+ if (descriptionGUID != null)
+ {
+ clonedTypeDef.setDescriptionGUID(descriptionGUID);
+ }
+
+ if (typeDefAttributes != null)
+ {
+ List<TypeDefAttribute> propertiesDefinition =
clonedTypeDef.getPropertiesDefinition();
+
+ if (propertiesDefinition == null)
+ {
+ // TODO throw patch error - attempting to Patch TypeDef with
no properties
+ }
+
+ for (TypeDefAttribute patchTypeDefAttribute : typeDefAttributes)
+ {
+ if (patchTypeDefAttribute != null)
+ {
+ String patchTypeDefAttributeName =
patchTypeDefAttribute.getAttributeName();
+
+ if (patchTypeDefAttributeName != null)
+ {
+ for (TypeDefAttribute existingProperty :
propertiesDefinition)
+ {
+ if (existingProperty != null)
+ {
+ if
(patchTypeDefAttributeName.equals(existingProperty.getAttributeName()))
+ {
+
+ }
+ }
+ else
+ {
+ // TODO throw Patch Error because basic Type
is messed up
+ }
+ }
+ }
+ else
+ {
+ // TODO throw Patch Error null attribute name
+ }
+ }
+ else
+ {
+ // TODO throw Patch Error null attribute included
+ }
+ }
+ }
+
+ return clonedTypeDef;
+ }
+
/*
* ======================
* OMRSInstanceHelper
@@ -299,8 +810,7 @@ public class OMRSRepositoryHelper implements
OMRSTypeDefHelper, OMRSInstanceHelp
else
{
OMRSErrorCode errorCode =
OMRSErrorCode.LOCAL_REPOSITORY_CONFIGURATION_ERROR;
- String errorMessage = errorCode.getErrorMessageId()
- + errorCode.getFormattedErrorMessage();
+ String errorMessage = errorCode.getErrorMessageId() +
errorCode.getFormattedErrorMessage();
throw new OMRSLogicErrorException(errorCode.getHTTPErrorCode(),
this.getClass().getName(),
@@ -346,6 +856,9 @@ public class OMRSRepositoryHelper implements
OMRSTypeDefHelper, OMRSInstanceHelp
classification.setCreateTime(new Date());
classification.setCreatedBy(userName);
classification.setVersion(1L);
+
classification.setType(repositoryContentManager.getInstanceType(sourceName,
+
TypeDefCategory.CLASSIFICATION_DEF,
+
classificationTypeName));
classification.setStatus(repositoryContentManager.getInitialStatus(sourceName,
classificationTypeName));
@@ -382,8 +895,7 @@ public class OMRSRepositoryHelper implements
OMRSTypeDefHelper, OMRSInstanceHelp
else
{
OMRSErrorCode errorCode =
OMRSErrorCode.LOCAL_REPOSITORY_CONFIGURATION_ERROR;
- String errorMessage = errorCode.getErrorMessageId()
- + errorCode.getFormattedErrorMessage();
+ String errorMessage = errorCode.getErrorMessageId() +
errorCode.getFormattedErrorMessage();
throw new OMRSLogicErrorException(errorCode.getHTTPErrorCode(),
this.getClass().getName(),
@@ -439,8 +951,42 @@ public class OMRSRepositoryHelper implements
OMRSTypeDefHelper, OMRSInstanceHelp
else
{
OMRSErrorCode errorCode =
OMRSErrorCode.LOCAL_REPOSITORY_CONFIGURATION_ERROR;
- String errorMessage = errorCode.getErrorMessageId()
- + errorCode.getFormattedErrorMessage();
+ String errorMessage = errorCode.getErrorMessageId() +
errorCode.getFormattedErrorMessage();
+
+ throw new OMRSLogicErrorException(errorCode.getHTTPErrorCode(),
+ this.getClass().getName(),
+ methodName,
+ errorMessage,
+ errorCode.getSystemAction(),
+ errorCode.getUserAction());
+ }
+ }
+
+
+ /**
+ * Return a relationship with the header and type information filled out.
The caller only needs to add properties
+ * to complete the set up of the relationship.
+ *
+ * @param sourceName - source of the request (used for logging)
+ * @param typeDefSummary - details of the new type
+ * @return instance type
+ * @throws TypeErrorException - the type name is not recognized as a
relationship type.
+ */
+ public InstanceType getNewInstanceType(String sourceName,
+ TypeDefSummary
typeDefSummary) throws TypeErrorException
+ {
+ final String methodName = "getNewInstanceType()";
+
+ if (repositoryContentManager != null)
+ {
+ return repositoryContentManager.getInstanceType(sourceName,
+
typeDefSummary.getCategory(),
+
typeDefSummary.getName());
+ }
+ else
+ {
+ OMRSErrorCode errorCode =
OMRSErrorCode.LOCAL_REPOSITORY_CONFIGURATION_ERROR;
+ String errorMessage = errorCode.getErrorMessageId() +
errorCode.getFormattedErrorMessage();
throw new OMRSLogicErrorException(errorCode.getHTTPErrorCode(),
this.getClass().getName(),
@@ -471,7 +1017,7 @@ public class OMRSRepositoryHelper implements
OMRSTypeDefHelper, OMRSInstanceHelp
String userName,
String typeName,
InstanceProperties properties,
- ArrayList<Classification>
classifications) throws TypeErrorException
+ List<Classification>
classifications) throws TypeErrorException
{
EntityDetail entity = this.getSkeletonEntity(sourceName,
metadataCollectionId,
@@ -487,7 +1033,7 @@ public class OMRSRepositoryHelper implements
OMRSTypeDefHelper, OMRSInstanceHelp
/**
- * Return a filled out relationship.
+ * Return a filled out relationship - just needs the entity proxies added.
*
* @param sourceName - source of the request (used for logging)
* @param metadataCollectionId - unique identifier for the home metadata
collection
@@ -548,4 +1094,396 @@ public class OMRSRepositoryHelper implements
OMRSTypeDefHelper, OMRSInstanceHelp
return classification;
}
+
+
+ /**
+ * Add a classification to an existing entity.
+ *
+ * @param sourceName - source of the request (used for logging)
+ * @param entity - entity to update
+ * @param newClassification - classification to update
+ * @param methodName - calling method
+ * @return updated entity
+ */
+ public EntityDetail addClassificationToEntity(String sourceName,
+ EntityDetail entity,
+ Classification
newClassification,
+ String methodName)
+ {
+ EntityDetail updatedEntity = new EntityDetail(entity);
+
+ if (newClassification != null)
+ {
+ /*
+ * Duplicate classifications are not allowed so a hash map is used
to remove duplicates.
+ */
+ HashMap<String, Classification> entityClassificationsMap = new
HashMap<>();
+ List<Classification> entityClassifications =
updatedEntity.getClassifications();
+
+ if (entityClassifications != null)
+ {
+ for (Classification existingClassification :
entityClassifications)
+ {
+ if (existingClassification != null)
+ {
+
entityClassificationsMap.put(existingClassification.getName(),
existingClassification);
+ }
+ }
+ }
+
+ entityClassificationsMap.put(newClassification.getName(),
newClassification);
+
+ if (entityClassificationsMap.isEmpty())
+ {
+ updatedEntity.setClassifications(null);
+ }
+ else
+ {
+ entityClassifications = new
ArrayList<>(entityClassificationsMap.values());
+
+ updatedEntity.setClassifications(entityClassifications);
+ }
+
+ return updatedEntity;
+ }
+ else
+ {
+ final String thisMethodName = "addClassificationToEntity";
+
+ OMRSErrorCode errorCode =
OMRSErrorCode.NULL_CLASSIFICATION_CREATED;
+ String errorMessage = errorCode.getErrorMessageId() +
errorCode.getFormattedErrorMessage(sourceName,
+
thisMethodName,
+
methodName);
+
+ throw new OMRSLogicErrorException(errorCode.getHTTPErrorCode(),
+ this.getClass().getName(),
+ methodName,
+ errorMessage,
+ errorCode.getSystemAction(),
+ errorCode.getUserAction());
+ }
+ }
+
+
+ /**
+ * Return the names classification from an existing entity.
+ *
+ * @param sourceName - source of the request (used for logging)
+ * @param entity - entity to update
+ * @param classificationName - classification to retrieve
+ * @param methodName - calling method
+ * @return located classification
+ * @throws ClassificationErrorException - the classification is not
attached to the entity
+ */
+ public Classification getClassificationFromEntity(String
sourceName,
+ EntityDetail entity,
+ String
classificationName,
+ String
methodName) throws ClassificationErrorException
+ {
+ final String thisMethodName = "getClassificationFromEntity";
+
+ if ((entity == null) || (classificationName == null))
+ {
+ OMRSErrorCode errorCode = OMRSErrorCode.VALIDATION_LOGIC_ERROR;
+ String errorMessage = errorCode.getErrorMessageId() +
errorCode.getFormattedErrorMessage(sourceName,
+
thisMethodName,
+
methodName);
+
+ throw new OMRSLogicErrorException(errorCode.getHTTPErrorCode(),
+ this.getClass().getName(),
+ methodName,
+ errorMessage,
+ errorCode.getSystemAction(),
+ errorCode.getUserAction());
+ }
+
+ List<Classification> entityClassifications =
entity.getClassifications();
+
+ if (entityClassifications != null)
+ {
+ for (Classification entityClassification : entityClassifications)
+ {
+ if (classificationName.equals(entityClassification.getName()))
+ {
+ return entityClassification;
+ }
+ }
+ }
+
+ OMRSErrorCode errorCode = OMRSErrorCode.ENTITY_NOT_CLASSIFIED;
+ String errorMessage = errorCode.getErrorMessageId() +
errorCode.getFormattedErrorMessage(methodName,
+
sourceName,
+
classificationName,
+
entity.getGUID());
+ throw new ClassificationErrorException(errorCode.getHTTPErrorCode(),
+ this.getClass().getName(),
+ methodName,
+ errorMessage,
+ errorCode.getSystemAction(),
+ errorCode.getUserAction());
+ }
+
+
+ /**
+ * Replace an existing classification with a new one
+ *
+ * @param sourceName - source of the request (used for logging)
+ * @param userName - name of the editor
+ * @param entity - entity to update
+ * @param newClassification - classification to update
+ * @param methodName - calling method
+ * @return updated entity
+ */
+ public EntityDetail updateClassificationInEntity(String sourceName,
+ String userName,
+ EntityDetail entity,
+ Classification
newClassification,
+ String methodName)
+ {
+ if (newClassification != null)
+ {
+ Classification updatedClassification = new
Classification(newClassification);
+
+ incrementVersion(userName, newClassification,
updatedClassification);
+
+ return this.addClassificationToEntity(sourceName, entity,
updatedClassification, methodName);
+ }
+ else
+ {
+ final String thisMethodName = "updateClassificationInEntity";
+
+ OMRSErrorCode errorCode =
OMRSErrorCode.NULL_CLASSIFICATION_CREATED;
+ String errorMessage = errorCode.getErrorMessageId() +
errorCode.getFormattedErrorMessage(sourceName,
+
thisMethodName,
+
methodName);
+
+ throw new OMRSLogicErrorException(errorCode.getHTTPErrorCode(),
+ this.getClass().getName(),
+ methodName,
+ errorMessage,
+ errorCode.getSystemAction(),
+ errorCode.getUserAction());
+ }
+ }
+
+
+ /**
+ * Return a oldClassification with the header and type information filled
out. The caller only needs to add properties
+ * to complete the set up of the oldClassification.
+ *
+ * @param sourceName - source of the request (used for logging)
+ * @param entity - entity to update
+ * @param oldClassificationName - classification to remove
+ * @param methodName - calling method
+ * @return updated entity
+ * @throws ClassificationErrorException - the entity was not classified
with this classification
+ */
+ public EntityDetail deleteClassificationFromEntity(String
sourceName,
+ EntityDetail entity,
+ String
oldClassificationName,
+ String
methodName) throws ClassificationErrorException
+ {
+ EntityDetail updatedEntity = new EntityDetail(entity);
+
+ if (oldClassificationName != null)
+ {
+ /*
+ * Duplicate classifications are not allowed so a hash map is used
to remove duplicates.
+ */
+ HashMap<String, Classification> entityClassificationsMap = new
HashMap<>();
+ List<Classification> entityClassifications =
updatedEntity.getClassifications();
+
+ if (entityClassifications != null)
+ {
+ for (Classification existingClassification :
entityClassifications)
+ {
+ if (existingClassification != null)
+ {
+
entityClassificationsMap.put(existingClassification.getName(),
existingClassification);
+ }
+ }
+ }
+
+ Classification oldClassification =
entityClassificationsMap.remove(oldClassificationName);
+
+ if (oldClassification == null)
+ {
+ OMRSErrorCode errorCode = OMRSErrorCode.ENTITY_NOT_CLASSIFIED;
+ String errorMessage = errorCode.getErrorMessageId() +
errorCode.getFormattedErrorMessage(methodName,
+
sourceName,
+
oldClassificationName,
+
entity.getGUID());
+ throw new
ClassificationErrorException(errorCode.getHTTPErrorCode(),
+
this.getClass().getName(),
+ methodName,
+ errorMessage,
+
errorCode.getSystemAction(),
+
errorCode.getUserAction());
+ }
+
+ if (entityClassificationsMap.isEmpty())
+ {
+ entity.setClassifications(null);
+ }
+ else
+ {
+ entityClassifications = new
ArrayList<>(entityClassificationsMap.values());
+
+ updatedEntity.setClassifications(entityClassifications);
+ }
+
+ return updatedEntity;
+ }
+ else
+ {
+ final String thisMethodName = "deleteClassificationFromEntity";
+
+ OMRSErrorCode errorCode = OMRSErrorCode.NULL_CLASSIFICATION_NAME;
+ String errorMessage = errorCode.getErrorMessageId() +
errorCode.getFormattedErrorMessage(sourceName,
+
thisMethodName,
+
methodName);
+
+ throw new OMRSLogicErrorException(errorCode.getHTTPErrorCode(),
+ this.getClass().getName(),
+ methodName,
+ errorMessage,
+ errorCode.getSystemAction(),
+ errorCode.getUserAction());
+ }
+ }
+
+
+ /**
+ * Merge two sets of instance properties.
+ *
+ * @param sourceName - source of the request (used for logging)
+ * @param existingProperties - current set of properties
+ * @param newProperties - properties to add/update
+ * @return merged properties
+ */
+ public InstanceProperties mergeInstanceProperties(String
sourceName,
+ InstanceProperties
existingProperties,
+ InstanceProperties
newProperties)
+ {
+ InstanceProperties mergedProperties;
+
+ if (existingProperties == null)
+ {
+ mergedProperties = newProperties;
+ }
+ else
+ {
+ mergedProperties = existingProperties;
+
+ if (newProperties != null)
+ {
+ Iterator<String> newPropertyNames =
newProperties.getPropertyNames();
+
+ while (newPropertyNames.hasNext())
+ {
+ String newPropertyName = newPropertyNames.next();
+
+ mergedProperties.setProperty(newPropertyName,
newProperties.getPropertyValue(newPropertyName));
+ }
+ }
+ }
+
+ return mergedProperties;
+ }
+
+
+ /**
+ * Changes the control information to reflect an update in an instance.
+ *
+ * @param userId - user making the change.
+ * @param originalInstance - original instance before the change
+ * @param updatedInstance - new version of the instance that needs updating
+ */
+ public void incrementVersion(String userId,
+ InstanceAuditHeader originalInstance,
+ InstanceAuditHeader updatedInstance)
+ {
+ updatedInstance.setUpdatedBy(userId);
+ updatedInstance.setUpdateTime(new Date());
+
+ long currentVersion = originalInstance.getVersion();
+ updatedInstance.setVersion(currentVersion ++);
+ }
+
+
+ /**
+ * Generate an entity proxy from an entity and its TypeDef.
+ *
+ * @param sourceName - source of the request (used for logging)
+ * @param entity - entity instance
+ * @return - new entity proxy
+ * @throws RepositoryErrorException - logic error in the repository -
corrupted entity
+ */
+ public EntityProxy getNewEntityProxy(String sourceName,
+ EntityDetail entity) throws
RepositoryErrorException
+ {
+
+ if (entity != null)
+ {
+ InstanceType type = entity.getType();
+
+ if (type != null)
+ {
+ try
+ {
+ TypeDef typeDef =
repositoryContentManager.getTypeDef(sourceName,
+
type.getTypeDefGUID(),
+
type.getTypeDefName());
+
+ EntityProxy entityProxy = new
EntityProxy(entity);
+ InstanceProperties entityProperties =
entity.getProperties();
+ List<TypeDefAttribute> propertiesDefinition =
typeDef.getPropertiesDefinition();
+ InstanceProperties uniqueAttributes = new
InstanceProperties();
+
+ for (TypeDefAttribute typeDefAttribute :
propertiesDefinition)
+ {
+ if (typeDefAttribute != null)
+ {
+ String propertyName =
typeDefAttribute.getAttributeName();
+
+ if ((typeDefAttribute.isUnique()) && (propertyName
!= null))
+ {
+ InstancePropertyValue propertyValue =
entityProperties.getPropertyValue(propertyName);
+
+ if (propertyValue != null)
+ {
+ uniqueAttributes.setProperty(propertyName,
propertyValue);
+ }
+ }
+ }
+ }
+
+ if (uniqueAttributes.getPropertyCount() > 0)
+ {
+ entityProxy.setUniqueProperties(uniqueAttributes);
+ }
+
+ return entityProxy;
+ }
+ catch (TypeErrorException error)
+ {
+ final String methodName = "getNewEntityProxy";
+
+ OMRSErrorCode errorCode =
OMRSErrorCode.REPOSITORY_LOGIC_ERROR;
+ String errorMessage = errorCode.getErrorMessageId() +
errorCode.getFormattedErrorMessage(sourceName,
+
methodName,
+
error.getErrorMessage());
+
+ throw new
RepositoryErrorException(errorCode.getHTTPErrorCode(),
+
this.getClass().getName(),
+ methodName,
+ errorMessage,
+
errorCode.getSystemAction(),
+
errorCode.getUserAction());
+ }
+ }
+ }
+
+ return null;
+ }
}
