org.odpi.openmetadata.accessservices.subjectarea.utils

Class DetectUtils

java.lang.Object

org.odpi.openmetadata.accessservices.subjectarea.utils.DetectUtils

public class DetectUtils
extends Object

Utility methods take a response and look for a particular type of response. For Exception response there are some detect and throw methods that throw, which look for a particular Exception and if it is found throws it.

Constructor Summary

Constructors

Constructor and Description
DetectUtils()

Method Summary

Modifier and Type	Method and Description
static Antonym	detectAndReturnAntonym(String className, String methodName, SubjectAreaOMASAPIResponse restResponse)
static List<Category>	detectAndReturnCategories(String className, String methodName, SubjectAreaOMASAPIResponse restResponse)
static Category	detectAndReturnCategory(String className, String methodName, SubjectAreaOMASAPIResponse restResponse) Detect and return a Category object from the supplied response.
static CategoryAnchor	detectAndReturnCategoryAnchorRelationship(String className, String methodName, SubjectAreaOMASAPIResponse restResponse)
static List<Glossary>	detectAndReturnGlossaries(String className, String methodName, SubjectAreaOMASAPIResponse restResponse)
static Glossary	detectAndReturnGlossary(String className, String methodName, SubjectAreaOMASAPIResponse restResponse) Detect and return a Glossary object from the supplied response.
static Graph	detectAndReturnGraph(String className, String methodName, SubjectAreaOMASAPIResponse restResponse)
static Isa	detectAndReturnISARelationship(String className, String methodName, SubjectAreaOMASAPIResponse restResponse)
static List<Line>	detectAndReturnLines(String className, String methodName, SubjectAreaOMASAPIResponse restResponse)
static PreferredTerm	detectAndReturnPreferredTerm(String className, String methodName, SubjectAreaOMASAPIResponse restResponse)
static Project	detectAndReturnProject(String className, String methodName, SubjectAreaOMASAPIResponse restResponse) Detect and return a Project object from the supplied response.
static List<Project>	detectAndReturnProjects(String className, String methodName, SubjectAreaOMASAPIResponse restResponse) Detect and return a List of Project objects from the supplied response.
static ProjectScope	detectAndReturnProjectScope(String className, String methodName, SubjectAreaOMASAPIResponse restResponse)
static RelatedTerm	detectAndReturnRelatedTerm(String className, String methodName, SubjectAreaOMASAPIResponse restResponse)
static ReplacementTerm	detectAndReturnReplacementTerm(String className, String methodName, SubjectAreaOMASAPIResponse restResponse)
static SemanticAssignment	detectAndReturnSemanticAssignmentRelationship(String className, String methodName, SubjectAreaOMASAPIResponse restResponse)
static SubjectAreaDefinition	detectAndReturnSubjectAreaDefinition(String className, String methodName, SubjectAreaOMASAPIResponse restResponse)
static Synonym	detectAndReturnSynonym(String className, String methodName, SubjectAreaOMASAPIResponse restResponse)
static Term	detectAndReturnTerm(String className, String methodName, SubjectAreaOMASAPIResponse restResponse) Detect and return a Term object from the supplied response.
static TermAnchor	detectAndReturnTermAnchorRelationship(String className, String methodName, SubjectAreaOMASAPIResponse restResponse)
static Categorization	detectAndReturnTermCategorizationRelationship(String className, String methodName, SubjectAreaOMASAPIResponse restResponse)
static Hasa	detectAndReturnTermHASARelationship(String className, String methodName, SubjectAreaOMASAPIResponse restResponse)
static IsaTypeOf	detectAndReturnTermISATypeOFRelationship(String className, String methodName, SubjectAreaOMASAPIResponse restResponse)
static List<Term>	detectAndReturnTerms(String className, String methodName, SubjectAreaOMASAPIResponse restResponse) Detect and return a List of Terms from the supplied response.
static TypedBy	detectAndReturnTermTYPEDBYRelationship(String className, String methodName, SubjectAreaOMASAPIResponse restResponse)
static Translation	detectAndReturnTranslation(String className, String methodName, SubjectAreaOMASAPIResponse restResponse)
static UsedInContext	detectAndReturnUsedInContext(String className, String methodName, SubjectAreaOMASAPIResponse restResponse)
static ValidValue	detectAndReturnValidValue(String className, String methodName, SubjectAreaOMASAPIResponse restResponse)
static void	detectAndThrowClassificationException(SubjectAreaOMASAPIResponse restResponse) Throw an ClassificationException if it is encoded in the REST response.
static void	detectAndThrowEntityNotDeletedException(SubjectAreaOMASAPIResponse restResponse) Throw an EntityNotDeletedException if it is encoded in the REST response.
static void	detectAndThrowEntityNotPurgedException(SubjectAreaOMASAPIResponse restResponse) Throw an EntityNotPurgedException if it is encoded in the REST response.
static void	detectAndThrowFunctionNotSupportedException(SubjectAreaOMASAPIResponse restResponse) Throw an FunctionNotSupportedException if it is encoded in the REST response.
static void	detectAndThrowInvalidParameterException(SubjectAreaOMASAPIResponse restResponse) Throw an InvalidParameterException if it is encoded in the REST response.
static void	detectAndThrowRelationshipNotDeletedException(SubjectAreaOMASAPIResponse restResponse) Throw an RelationshipNotDeletedException if it is encoded in the REST response.
static void	detectAndThrowRelationshipNotPurgedException(SubjectAreaOMASAPIResponse restResponse) Throw an RelationshipNotPurgedException if it is encoded in the REST response.
static void	detectAndThrowStatusNotSupportedException(SubjectAreaOMASAPIResponse restResponse) Throw an StatusNotSupportedException if it is encoded in the REST response.
static void	detectAndThrowUnrecognizedGUIDException(SubjectAreaOMASAPIResponse restResponse) Throw an UnrecognizedGUIDException if it is encoded in the REST response.
static void	detectAndThrowUserNotAuthorizedException(SubjectAreaOMASAPIResponse restResponse) Throw an UserNotAuthorizedException if it is encoded in the REST response.
static void	detectVoid(String className, String methodName, SubjectAreaOMASAPIResponse restResponse) Detect Void return.
static SubjectAreaOMASAPIResponse	getResponseFromException(SubjectAreaCheckedException e) Convert a subject area a checked exception to a response

Methods inherited from class java.lang.Object

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

Constructor Detail

DetectUtils

public DetectUtils()

Method Detail

detectAndThrowInvalidParameterException

public static void detectAndThrowInvalidParameterException(SubjectAreaOMASAPIResponse restResponse)
                                                    throws InvalidParameterException

Throw an InvalidParameterException if it is encoded in the REST response.

Parameters:

restResponse - - response from the rest call. This generated in the remote handlers.

Throws:

InvalidParameterException - - encoded exception from the handlers

detectAndThrowUnrecognizedGUIDException

public static void detectAndThrowUnrecognizedGUIDException(SubjectAreaOMASAPIResponse restResponse)
                                                    throws UnrecognizedGUIDException

Throw an UnrecognizedGUIDException if it is encoded in the REST response.

Parameters:

restResponse - - response from the rest call. This generated in the remote handlers.

Throws:

UnrecognizedGUIDException - - encoded exception from the handlers

detectAndThrowClassificationException

public static void detectAndThrowClassificationException(SubjectAreaOMASAPIResponse restResponse)
                                                  throws ClassificationException

Throw an ClassificationException if it is encoded in the REST response.

Parameters:

restResponse - - response from the rest call. This generated in the remote handlers.

Throws:

ClassificationException - - encoded exception from the handlers

detectAndThrowEntityNotDeletedException

public static void detectAndThrowEntityNotDeletedException(SubjectAreaOMASAPIResponse restResponse)
                                                    throws EntityNotDeletedException

Throw an EntityNotDeletedException if it is encoded in the REST response.

Parameters:

restResponse - - response from the rest call. This generated in the remote handlers.

Throws:

EntityNotDeletedException - - encoded exception from the handlers

detectAndThrowFunctionNotSupportedException

public static void detectAndThrowFunctionNotSupportedException(SubjectAreaOMASAPIResponse restResponse)
                                                        throws FunctionNotSupportedException

Throw an FunctionNotSupportedException if it is encoded in the REST response.

Parameters:

restResponse - - response from the rest call. This generated in the remote handlers.

Throws:

FunctionNotSupportedException - - encoded exception from the handlers

detectAndThrowEntityNotPurgedException

public static void detectAndThrowEntityNotPurgedException(SubjectAreaOMASAPIResponse restResponse)
                                                   throws EntityNotPurgedException

Throw an EntityNotPurgedException if it is encoded in the REST response.

Parameters:

restResponse - - response from the rest call. This generated in the remote handlers.

Throws:

EntityNotPurgedException - - encoded exception from the handlers

detectAndThrowRelationshipNotDeletedException

public static void detectAndThrowRelationshipNotDeletedException(SubjectAreaOMASAPIResponse restResponse)
                                                          throws RelationshipNotDeletedException

Throw an RelationshipNotDeletedException if it is encoded in the REST response.

Parameters:

restResponse - - response from the rest call. This generated in the remote handlers.

Throws:

RelationshipNotDeletedException - - encoded exception from the handlers

detectAndThrowRelationshipNotPurgedException

public static void detectAndThrowRelationshipNotPurgedException(SubjectAreaOMASAPIResponse restResponse)
                                                         throws RelationshipNotPurgedException

Throw an RelationshipNotPurgedException if it is encoded in the REST response.

Parameters:

restResponse - - response from the rest call. This generated in the remote handlers.

Throws:

RelationshipNotPurgedException - - encoded exception from the handlers

detectAndThrowStatusNotSupportedException

public static void detectAndThrowStatusNotSupportedException(SubjectAreaOMASAPIResponse restResponse)
                                                      throws StatusNotSupportedException

Throw an StatusNotSupportedException if it is encoded in the REST response.

Parameters:

restResponse - - response from the rest call. This generated in the remote handlers.

Throws:

StatusNotSupportedException - - encoded exception from the handlers

detectAndThrowUserNotAuthorizedException

public static void detectAndThrowUserNotAuthorizedException(SubjectAreaOMASAPIResponse restResponse)
                                                     throws UserNotAuthorizedException

Throw an UserNotAuthorizedException if it is encoded in the REST response.

Parameters:

restResponse - - response from the rest call. This generated in the remote handlers.

Throws:

UserNotAuthorizedException - - encoded exception from the handlers

detectVoid

public static void detectVoid(String className,
                              String methodName,
                              SubjectAreaOMASAPIResponse restResponse)
                       throws UnexpectedResponseException

Detect Void return. If we do not find one then throw an Exception

Parameters:

className - name of the class.

methodName - method being performed.

restResponse - - response from the rest call. This generated in the remote handlers.

Throws:

UnexpectedResponseException - - if the response is not a glossary then throw this exception

detectAndReturnGlossary

public static Glossary detectAndReturnGlossary(String className,
                                               String methodName,
                                               SubjectAreaOMASAPIResponse restResponse)
                                        throws UnexpectedResponseException

Detect and return a Glossary object from the supplied response. If we do not find one then throw an Exception

Parameters:

className - name of the class.

methodName - method being performed.

restResponse - - response from the rest call. This generated in the remote handlers.

Returns:

Glossary if the supplied response is a glossary response

Throws:

UnexpectedResponseException - - if the response is not a glossary then throw this exception

detectAndReturnGlossaries

public static List<Glossary> detectAndReturnGlossaries(String className,
                                                       String methodName,
                                                       SubjectAreaOMASAPIResponse restResponse)
                                                throws UnexpectedResponseException

Throws:

UnexpectedResponseException

detectAndReturnProject

public static Project detectAndReturnProject(String className,
                                             String methodName,
                                             SubjectAreaOMASAPIResponse restResponse)
                                      throws UnexpectedResponseException

Detect and return a Project object from the supplied response. If we do not find one then throw an Exception

Parameters:

className - name of the class.

methodName - method being performed.

restResponse - - response from the rest call. This generated in the remote handlers.

Returns:

Project if the supplied response is a project response

Throws:

UnexpectedResponseException - - if the response is not a project then throw this exception

detectAndReturnProjects

public static List<Project> detectAndReturnProjects(String className,
                                                    String methodName,
                                                    SubjectAreaOMASAPIResponse restResponse)
                                             throws UnexpectedResponseException

Detect and return a List of Project objects from the supplied response. If we do not find one then throw an Exception

Parameters:

className - name of the class.

methodName - method being performed.

restResponse - - response from the rest call. This generated in the remote handlers.

Returns:

Projects if the supplied response is a project response

Throws:

UnexpectedResponseException - - if the response is not a project then throw this exception

detectAndReturnTerm

public static Term detectAndReturnTerm(String className,
                                       String methodName,
                                       SubjectAreaOMASAPIResponse restResponse)
                                throws UnexpectedResponseException

Detect and return a Term object from the supplied response. If we do not find one then throw an Exception

Parameters:

className - name of the class.

methodName - method being performed.

restResponse - - response from the rest call. This generated in the remote handlers.

Returns:

Term if the supplied response is a term response

Throws:

UnexpectedResponseException - - if the response is not a Term then throw this exception

detectAndReturnTerms

public static List<Term> detectAndReturnTerms(String className,
                                              String methodName,
                                              SubjectAreaOMASAPIResponse restResponse)
                                       throws UnexpectedResponseException

Detect and return a List of Terms from the supplied response. If we do not find one then throw an Exception

Parameters:

className - name of the class.

methodName - method being performed.

restResponse - - response from the rest call. This generated in the remote handlers.

Returns:

List of Terms if the supplied response is a terms response

Throws:

UnexpectedResponseException - - if the response is not a Terms then throw this exception

detectAndReturnGraph

public static Graph detectAndReturnGraph(String className,
                                         String methodName,
                                         SubjectAreaOMASAPIResponse restResponse)
                                  throws UnexpectedResponseException

Throws:

UnexpectedResponseException

detectAndReturnLines

public static List<Line> detectAndReturnLines(String className,
                                              String methodName,
                                              SubjectAreaOMASAPIResponse restResponse)
                                       throws UnexpectedResponseException

Throws:

UnexpectedResponseException

detectAndReturnCategory

public static Category detectAndReturnCategory(String className,
                                               String methodName,
                                               SubjectAreaOMASAPIResponse restResponse)
                                        throws UnexpectedResponseException

Detect and return a Category object from the supplied response. If we do not find one then throw an Exception

Parameters:

className - name of the class.

methodName - method being performed.

restResponse - - response from the rest call. This generated in the remote handlers.

Returns:

Category if the supplied response is a category response

Throws:

UnexpectedResponseException - - if the response is not a Category then throw this exception

detectAndReturnCategories

public static List<Category> detectAndReturnCategories(String className,
                                                       String methodName,
                                                       SubjectAreaOMASAPIResponse restResponse)
                                                throws UnexpectedResponseException

Throws:

UnexpectedResponseException

detectAndReturnSubjectAreaDefinition

public static SubjectAreaDefinition detectAndReturnSubjectAreaDefinition(String className,
                                                                         String methodName,
                                                                         SubjectAreaOMASAPIResponse restResponse)
                                                                  throws UnexpectedResponseException

Throws:

UnexpectedResponseException

detectAndReturnTermHASARelationship

public static Hasa detectAndReturnTermHASARelationship(String className,
                                                       String methodName,
                                                       SubjectAreaOMASAPIResponse restResponse)
                                                throws UnexpectedResponseException

Throws:

UnexpectedResponseException

detectAndReturnRelatedTerm

public static RelatedTerm detectAndReturnRelatedTerm(String className,
                                                     String methodName,
                                                     SubjectAreaOMASAPIResponse restResponse)
                                              throws UnexpectedResponseException

Throws:

UnexpectedResponseException

detectAndReturnSynonym

public static Synonym detectAndReturnSynonym(String className,
                                             String methodName,
                                             SubjectAreaOMASAPIResponse restResponse)
                                      throws UnexpectedResponseException

Throws:

UnexpectedResponseException

detectAndReturnAntonym

public static Antonym detectAndReturnAntonym(String className,
                                             String methodName,
                                             SubjectAreaOMASAPIResponse restResponse)
                                      throws UnexpectedResponseException

Throws:

UnexpectedResponseException

detectAndReturnTranslation

public static Translation detectAndReturnTranslation(String className,
                                                     String methodName,
                                                     SubjectAreaOMASAPIResponse restResponse)
                                              throws UnexpectedResponseException

Throws:

UnexpectedResponseException

detectAndReturnUsedInContext

public static UsedInContext detectAndReturnUsedInContext(String className,
                                                         String methodName,
                                                         SubjectAreaOMASAPIResponse restResponse)
                                                  throws UnexpectedResponseException

Throws:

UnexpectedResponseException

detectAndReturnPreferredTerm

public static PreferredTerm detectAndReturnPreferredTerm(String className,
                                                         String methodName,
                                                         SubjectAreaOMASAPIResponse restResponse)
                                                  throws UnexpectedResponseException

Throws:

UnexpectedResponseException

detectAndReturnValidValue

public static ValidValue detectAndReturnValidValue(String className,
                                                   String methodName,
                                                   SubjectAreaOMASAPIResponse restResponse)
                                            throws UnexpectedResponseException

Throws:

UnexpectedResponseException

detectAndReturnReplacementTerm

public static ReplacementTerm detectAndReturnReplacementTerm(String className,
                                                             String methodName,
                                                             SubjectAreaOMASAPIResponse restResponse)
                                                      throws UnexpectedResponseException

Throws:

UnexpectedResponseException

detectAndReturnTermTYPEDBYRelationship

public static TypedBy detectAndReturnTermTYPEDBYRelationship(String className,
                                                             String methodName,
                                                             SubjectAreaOMASAPIResponse restResponse)
                                                      throws UnexpectedResponseException

Throws:

UnexpectedResponseException

detectAndReturnISARelationship

public static Isa detectAndReturnISARelationship(String className,
                                                 String methodName,
                                                 SubjectAreaOMASAPIResponse restResponse)
                                          throws UnexpectedResponseException

Throws:

UnexpectedResponseException

detectAndReturnTermISATypeOFRelationship

public static IsaTypeOf detectAndReturnTermISATypeOFRelationship(String className,
                                                                 String methodName,
                                                                 SubjectAreaOMASAPIResponse restResponse)
                                                          throws UnexpectedResponseException

Throws:

UnexpectedResponseException

detectAndReturnSemanticAssignmentRelationship

public static SemanticAssignment detectAndReturnSemanticAssignmentRelationship(String className,
                                                                               String methodName,
                                                                               SubjectAreaOMASAPIResponse restResponse)
                                                                        throws UnexpectedResponseException

Throws:

UnexpectedResponseException

detectAndReturnTermCategorizationRelationship

public static Categorization detectAndReturnTermCategorizationRelationship(String className,
                                                                           String methodName,
                                                                           SubjectAreaOMASAPIResponse restResponse)
                                                                    throws UnexpectedResponseException

Throws:

UnexpectedResponseException

detectAndReturnTermAnchorRelationship

public static TermAnchor detectAndReturnTermAnchorRelationship(String className,
                                                               String methodName,
                                                               SubjectAreaOMASAPIResponse restResponse)
                                                        throws UnexpectedResponseException

Throws:

UnexpectedResponseException

detectAndReturnCategoryAnchorRelationship

public static CategoryAnchor detectAndReturnCategoryAnchorRelationship(String className,
                                                                       String methodName,
                                                                       SubjectAreaOMASAPIResponse restResponse)
                                                                throws UnexpectedResponseException

Throws:

UnexpectedResponseException

detectAndReturnProjectScope

public static ProjectScope detectAndReturnProjectScope(String className,
                                                       String methodName,
                                                       SubjectAreaOMASAPIResponse restResponse)
                                                throws UnexpectedResponseException

Throws:

UnexpectedResponseException

getResponseFromException

public static SubjectAreaOMASAPIResponse getResponseFromException(SubjectAreaCheckedException e)

Convert a subject area a checked exception to a response

Parameters:

e - Exception to comnvert

Returns:

the relevant exception response