com.exalead.cloudview.consolidationapi

Class TransformationHelpers

java.lang.Object

com.exalead.cloudview.consolidationapi.TransformationHelpers

public class TransformationHelpers
extends java.lang.Object

Provide helper functions mainly to build `Transformation` directives values.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	buildAddArcFromDirectiveValue(java.lang.String arcType, java.lang.String fromDocURI) Build a TransformationDirective.PREDECESSORS_ADDITION_META directive value.
static java.lang.String	buildAddArcFromDirectiveValue(java.lang.String arcType, java.lang.String rootDocumentURI, java.lang.String targetDocumentURI) Build a TransformationDirective#INCOMING_ARC_ADDITION_META directive value.
static java.lang.String	buildAddArcToDirectiveValue(java.lang.String arcType, java.lang.String toDocURI) Build a TransformationDirective.SUCCESSORS_ADDITION_META directive value.
static java.lang.String	buildAddArcToDirectiveValue(java.lang.String arcType, java.lang.String rootDocumentURI, java.lang.String targetDocumentURI) Build a TransformationDirective#OUTGOING_ARC_ADDITION_META directive value.
static java.lang.String	buildRemoveArcFromDirectiveValue(java.lang.String arcType, java.lang.String fromDocURI) Build a TransformationDirective.PREDECESSORS_DELETION_META directive value.
static java.lang.String	buildRemoveArcFromDirectiveValue(java.lang.String arcType, java.lang.String rootDocumentURI, java.lang.String targetDocumentURI) Build a TransformationDirective.INCOMING_ARC_DELETION directive value.
static java.lang.String	buildRemoveArcToDirectiveValue(java.lang.String arcType, java.lang.String toDocURI) Build a TransformationDirective.SUCCESSORS_DELETION_META directive value.
static java.lang.String	buildRemoveArcToDirectiveValue(java.lang.String arcType, java.lang.String rootDocumentURI, java.lang.String targetDocumentURI) Build a TransformationDirective.OUTGOING_ARC_DELETION directive value.
static java.lang.String	buildTypeInheritanceDirectiveValue(java.lang.String type, java.lang.String... parentTypes) Build a ConsolidationDirective.DOCUMENT_TYPE directive value for a document.
static java.util.List<java.lang.String>	buildTypeInheritanceList(java.lang.String type, java.lang.String... parentTypes) Creates document's type inheritance list.
static <T> T	checkNotNull(T ref, java.lang.Object errorMessage)
static java.lang.String	checkNotNullAndNotEmpty(java.lang.String str, java.lang.Object errorMessage)
static java.lang.String	getDocumentChildrenPath(java.lang.String uri) Returns the document children path for the given document URI.
static java.lang.String	getDocumentChildrenPath(java.lang.String uri, java.lang.String path) Returns the document children path for the given document URI, and optionally append an additional path.
static java.lang.String	validateInput(java.lang.String inputValue, char[] set)
static java.lang.String	validateMonoValuedInput(java.lang.String inputValue) Validates the given mono-valued input value.
static java.lang.String	validateMultiValuedInput(java.lang.String inputValue) Validates the given multi-valued input value.

Methods inherited from class java.lang.Object

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

Method Detail

buildAddArcFromDirectiveValue

public static java.lang.String buildAddArcFromDirectiveValue(@Nonnull
                                                             java.lang.String arcType,
                                                             @Nonnull
                                                             java.lang.String fromDocURI)

Build a TransformationDirective.PREDECESSORS_ADDITION_META directive value.

Parameters:

arcType - The arc type to consider.

fromDocURI - The URI of the other document defining the arc tail.

Returns:

a ConsolidationDirective#PREDECESSORS_ADDITION_META directive value

buildAddArcFromDirectiveValue

public static java.lang.String buildAddArcFromDirectiveValue(@Nonnull
                                                             java.lang.String arcType,
                                                             @Nonnull
                                                             java.lang.String rootDocumentURI,
                                                             @Nonnull
                                                             java.lang.String targetDocumentURI)

Build a TransformationDirective#INCOMING_ARC_ADDITION_META directive value.

Parameters:

arcType - The arc type to consider.

rootDocumentURI - The URI of the root document.

targetDocumentURI - The URI of the target document.

Returns:

a ConsolidationDirective#INCOMING_ARC_ADDITION_META directive value

buildAddArcToDirectiveValue

public static java.lang.String buildAddArcToDirectiveValue(@Nonnull
                                                           java.lang.String arcType,
                                                           @Nonnull
                                                           java.lang.String toDocURI)

Build a TransformationDirective.SUCCESSORS_ADDITION_META directive value.

Parameters:

arcType - The arc type to consider.

toDocURI - The URI of the other document defining the arc head.

Returns:

a ConsolidationDirective#SUCCESSORS_ADDITION_META directive value

buildAddArcToDirectiveValue

public static java.lang.String buildAddArcToDirectiveValue(@Nonnull
                                                           java.lang.String arcType,
                                                           @Nonnull
                                                           java.lang.String rootDocumentURI,
                                                           @Nonnull
                                                           java.lang.String targetDocumentURI)

Build a TransformationDirective#OUTGOING_ARC_ADDITION_META directive value.

Parameters:

arcType - The arc type to consider.

rootDocumentURI - The URI of the root document.

targetDocumentURI - The URI of the target document.

Returns:

a ConsolidationDirective#OUTGOING_ARC_ADDITION_META directive value

buildRemoveArcFromDirectiveValue

public static java.lang.String buildRemoveArcFromDirectiveValue(@Nonnull
                                                                java.lang.String arcType,
                                                                @Nonnull
                                                                java.lang.String fromDocURI)

Build a TransformationDirective.PREDECESSORS_DELETION_META directive value.

Parameters:

arcType - The arc type to consider.

fromDocURI - The URI of the other document defining the arc tail.

Returns:

a ConsolidationDirective#PREDECESSORS_DELETION_META directive value

buildRemoveArcFromDirectiveValue

public static java.lang.String buildRemoveArcFromDirectiveValue(@Nonnull
                                                                java.lang.String arcType,
                                                                @Nonnull
                                                                java.lang.String rootDocumentURI,
                                                                @Nonnull
                                                                java.lang.String targetDocumentURI)

Build a TransformationDirective.INCOMING_ARC_DELETION directive value.

Parameters:

arcType - The arc type to consider.

rootDocumentURI - The URI of the root document.

targetDocumentURI - The URI of the target document.

Returns:

a ConsolidationDirective#INCOMING_ARC_DELETION directive value

buildRemoveArcToDirectiveValue

public static java.lang.String buildRemoveArcToDirectiveValue(@Nonnull
                                                              java.lang.String arcType,
                                                              @Nonnull
                                                              java.lang.String toDocURI)

Build a TransformationDirective.SUCCESSORS_DELETION_META directive value.

Parameters:

arcType - The arc type to consider.

toDocURI - The URI of the other document defining the arc head.

Returns:

a ConsolidationDirective#SUCCESSORS_DELETION_META directive value

buildRemoveArcToDirectiveValue

public static java.lang.String buildRemoveArcToDirectiveValue(@Nonnull
                                                              java.lang.String arcType,
                                                              @Nonnull
                                                              java.lang.String rootDocumentURI,
                                                              @Nonnull
                                                              java.lang.String targetDocumentURI)

Build a TransformationDirective.OUTGOING_ARC_DELETION directive value.

Parameters:

arcType - The arc type to consider.

rootDocumentURI - The URI of the root document.

targetDocumentURI - The URI of the target document.

Returns:

a ConsolidationDirective#OUTGOING_ARC_DELETION directive value

buildTypeInheritanceDirectiveValue

public static java.lang.String buildTypeInheritanceDirectiveValue(java.lang.String type,
                                                                  java.lang.String... parentTypes)

Build a ConsolidationDirective.DOCUMENT_TYPE directive value for a document.

Parameters:

documentType - The document representative type.

parentTypes - A possible list of parent types ordered from their natural hierarchy.

Returns:

a ConsolidationDirective.DOCUMENT_TYPE directive value

buildTypeInheritanceList

public static java.util.List<java.lang.String> buildTypeInheritanceList(java.lang.String type,
                                                                        java.lang.String... parentTypes)

Creates document's type inheritance list.

Parameters:

type - the type of a document

parentTypes - the parent types of a document

Returns:

a list of document type

validateMonoValuedInput

public static final java.lang.String validateMonoValuedInput(java.lang.String inputValue)

Validates the given mono-valued input value.

Parameters:

inputValue - the mono-valued input value

Returns:

a valid mono-valued input value

Throws:

java.lang.IllegalArgumentException - if not a valid mono valued input

validateMultiValuedInput

public static final java.lang.String validateMultiValuedInput(java.lang.String inputValue)

Validates the given multi-valued input value.

Parameters:

inputValue - the multi-valued input value

Returns:

a valid multi-valued input value

Throws:

java.lang.IllegalArgumentException - if not a valid mono valued input

getDocumentChildrenPath

public static java.lang.String getDocumentChildrenPath(java.lang.String uri)

Returns the document children path for the given document URI.

Parameters:

uri - the given document URI

Returns:

the document children path for the given document URI

getDocumentChildrenPath

public static java.lang.String getDocumentChildrenPath(java.lang.String uri,
                                                       java.lang.String path)

Returns the document children path for the given document URI, and optionally append an additional path.

Parameters:

uri - the given document URI

Returns:

the document children path for the given document URI

checkNotNull

public static <T> T checkNotNull(T ref,
                                 @Nullable
                                 java.lang.Object errorMessage)

checkNotNullAndNotEmpty

public static java.lang.String checkNotNullAndNotEmpty(java.lang.String str,
                                                       @Nullable
                                                       java.lang.Object errorMessage)

validateInput

public static final java.lang.String validateInput(java.lang.String inputValue,
                                                   char[] set)