com.foreach.across.modules.webcms.infrastructure

Class WebCmsUtils

java.lang.Object

com.foreach.across.modules.webcms.infrastructure.WebCmsUtils

public class WebCmsUtils
extends Object

Since:

0.0.1

Author:

Arne Vandamme

Method Summary

Modifier and Type	Method and Description
static String	combineUrlSegments(@NonNull String baseUrl, @NonNull String path) Create a full url by combining a base with a path segment.
static WebCmsDataAction	convertImportActionToDataAction(Object existing, WebCmsDataImportAction requested)
static String	generateCanonicalPath(@NonNull WebCmsPage page) Generates a unique canonical path for a WebCmsPage.
static String	generateObjectId(@NonNull String collectionId) Generate a unique object id for the given collection.
static String	generateUrlPathSegment(@NonNull String text) Convert text into a valid path segment for url.
static boolean	isObjectIdForCollection(String objectId, @NonNull String collectionId) Checks if an object id is for a given collection.
static boolean	isPublishedOnDate(@NonNull WebCmsAsset asset, @NonNull Date date) Is the given asset published on a particular date.
static String	prefixObjectIdForCollection(@NonNull String objectId, @NonNull String collectionId) Ensures a unique id is for a given collection.

Methods inherited from class java.lang.Object

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

Method Detail

isPublishedOnDate

public static boolean isPublishedOnDate(@NonNull
                                        @NonNull WebCmsAsset asset,
                                        @NonNull
                                        @NonNull Date date)

Is the given asset published on a particular date. This means that the WebCmsAsset#isPublished() returns true and the WebCmsAsset#getPublicationDate() is either null or before the date parameter.

Parameters:

asset - to check

date - to check for

Returns:

true if asset is published

generateObjectId

public static String generateObjectId(@NonNull
                                      @NonNull String collectionId)

Generate a unique object id for the given collection. A collection is represented by an id (eg. wcm:asset:page) and a unique id with the collection id as prefix will be returned.

Parameters:

collectionId - the key should have

Returns:

unique key

prefixObjectIdForCollection

public static String prefixObjectIdForCollection(@NonNull
                                                 @NonNull String objectId,
                                                 @NonNull
                                                 @NonNull String collectionId)

Ensures a unique id is for a given collection. If the object id starts with the collection id, it will be left unchanged, else the collection id will be prefixed.

Parameters:

objectId - requested

collectionId - the key should have

Returns:

collection prefixed key

isObjectIdForCollection

public static boolean isObjectIdForCollection(String objectId,
                                              @NonNull
                                              @NonNull String collectionId)

Checks if an object id is for a given collection.

Parameters:

objectId - to check

collectionId - the object id should have

Returns:

true if object id is for the collection

generateUrlPathSegment

public static String generateUrlPathSegment(@NonNull
                                            @NonNull String text)

Convert text into a valid path segment for url. This will make an seo friendly path.

Parameters:

text - to convert

Returns:

path segment

generateCanonicalPath

public static String generateCanonicalPath(@NonNull
                                           @NonNull WebCmsPage page)

Generates a unique canonical path for a WebCmsPage. The canonical path is the canonical path of its (optional) parent joined together with its own path segment using a / character (forward slash).

Parameters:

page - to generate the path for

Returns:

canonical path

combineUrlSegments

public static String combineUrlSegments(@NonNull
                                        @NonNull String baseUrl,
                                        @NonNull
                                        @NonNull String path)

Create a full url by combining a base with a path segment. If the baseUrl contains a * marker, the path will be injected into the marker, else the path will simply be appended.

Parameters:

baseUrl - that may or may not contain a * marker

path - to inject into the base url

Returns:

combined

convertImportActionToDataAction

public static WebCmsDataAction convertImportActionToDataAction(Object existing,
                                                               WebCmsDataImportAction requested)