eu.lundegaard.liferay.db.setup.core.util

Class ResolverUtil

java.lang.Object

eu.lundegaard.liferay.db.setup.core.util.ResolverUtil

public final class ResolverUtil
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	ID_TYPE_FILE
static int	ID_TYPE_ID
static int	ID_TYPE_RESOURCE
static int	ID_TYPE_UUID

Method Summary

Modifier and Type	Method and Description
static com.liferay.journal.model.JournalArticle	getArticleByArticleID(String articleId, long groupId)
static String	getClassIdByName(String value, String locationHint)
static com.liferay.portal.kernel.model.Organization	getOrganization(String name, long companyId, String locationHint)
static long	getSiteGroupIdByName(String siteName, long company, String locationName)
static long	getStructureId(String structureKey, long groupId, Class clazz, boolean includeAncestorStructures)
static String	getStructureUUID(String structureKey, long groupId, Class clazz)
static long	getTemplateId(String templateKey, long groupId, Class clazz)
static String	getTemplateUUID(String templateKey, long groupId)
static com.liferay.portal.kernel.model.UserGroup	getUserGroup(String name, long companyId, String locationHint)
static String	lookupAll(long runAsUserId, long groupId, long company, String value, String resolverHint) Resolves a value with a given key inside a given content.
static String	lookupArticleWithArticleId(String content, String locationHint, long groupId, long company, int typeOfId)
static String	lookupDDLRecordSetId(String content, String locationHint, long groupId, long company)
static String	lookupOrgOrUserGroupIdWithName(String locationHint, String value, long company, boolean uuid, boolean org)
static String	lookupPageIdWithFriendlyUrl(String content, String locationHint, long groupId, long company, boolean isPrivate, IdMode mode)
static String	lookupSiteIdWithName(String locationHint, String value, long company)
static String	lookupStructureOrTemplateIdWithKey(String content, String locationHint, long groupId, long company, boolean uuid, String commandPrefix, boolean isTemplate, Class referredClass)
static String	substituteCategoryNameWithCategoryId(String content, String locationHint, long groupId, long company, long userId)
static String	substituteFileReferencesWithURL(String content, String locationHint, long groupId, long company, long repoId, long userId, int refType) Substitutes all references for documents and media files.

Methods inherited from class java.lang.Object

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

Field Detail

ID_TYPE_ID

public static final int ID_TYPE_ID

See Also:

Constant Field Values

ID_TYPE_UUID

public static final int ID_TYPE_UUID

See Also:

Constant Field Values

ID_TYPE_RESOURCE

public static final int ID_TYPE_RESOURCE

See Also:

Constant Field Values

ID_TYPE_FILE

public static final int ID_TYPE_FILE

See Also:

Constant Field Values

Method Detail

lookupAll

public static String lookupAll(long runAsUserId,
                               long groupId,
                               long company,
                               String value,
                               String resolverHint)

Resolves a value with a given key inside a given content. Every occurance of one of the following expressions is substituted by the resolved value:

• {{$ARTICLE-ID-BY-ARTICLE-ID=[:: name of the site ::]< article id to look for > $}}
• {{$ARTICLE-UUIID-BY-ARTICLE-ID=[:: name of the site ::]< article id to look for >$}}
• {{$ARTICLE-RESID-BY-ARTICLE-ID=[:: name of the site ::]< article id to look for >$}}
• {{$ART-TEMPLATE-ID-BY-KEY=[:: name of the site ::]< article id to look for > $}}
• {{$ART-TEMPLATE-UUID-BY-KEY=[:: name of the site ::]< article id to look for > $}}
• {{$ART-STRUCTURE-ID-BY-KEY=[:: name of the site ::]< article id to look for > $}}
• {{$ART-STRUCTURE-UUID-BY-KEY=[:: name of the site ::]< article id to look for > $}}
• {{$ADT-TEMPLATE-ID-BY-KEY=[:: name of the site ::]< article id to look for > $}}
• {{$ADT-TEMPLATE-UUID-BY-KEY=[:: name of the site ::]< article id to look for > $}}
• {{$FILE-JSON=[:: name of the site ::]< documents and media folder path to the file >< documents and media folder title of the file >$}}
• {{$FILE-ID=[:: name of the site ::]< documents and media folder path to the file >< documents and media folder title of the file >$}}
• {{$FILE-UUID=[:: name of the site ::]< documents and media folder path to the file >< documents and media folder title of the file >$}}
• {{$CLASS-ID-BY-NAME=< fully qualified class name >$}}
• {{$PRIV-PAGE-ID-BY-FRIENDLY_URL=[:: name of the site ::]< friendly url of the private page >$}}
• {{$PUB-PAGE-ID-BY-FRIENDLY_URL=[:: name of the site ::]< friendly url of the public page >$}}
• {{$PRIV-PAGE-PLID-BY-FRIENDLY_URL=[:: name of the site ::]< friendly url of the private page >$}}
• {{$PUB-PAGE-PLID-BY-FRIENDLY_URL=[:: name of the site ::]< friendly url of the public page >$}}
• {{$PUB-PAGE-UUID-BY-FRIENDLY_URL=[:: name of the site ::]< friendly url of the public page >$}}
• {{$DDL-REC-SET-ID-BY-KEYL=[:: name of the site ::]< key of the DDL record set > $}}
• {{ID_OF_ORG_WITH_NAME=< name of the organization >$}}
• {{UUID_OF_ORG_WITH_NAME=< name of the organization >$}}
• {{ID_OF_USER_GROUP_WITH_NAME=< name of the user group >$}}
• {{UUDID_OF_USER_GROUP_WITH_NAME=< name of the user group >$}}

Parameters:

runAsUserId - The user id under which the look up is done.

groupId - the group id which is used by default for the look up.

company - the company id that is used for the default look up.

value - the value string in which the occurance of any above resolve expression is resolved.

resolverHint - the resovler hint textually specifies where the value is from and is used for logging problems or infos on the resolution.

Returns:

Returns the string value with any resolver expression resolved to the corresponding elements.

getClassIdByName

public static String getClassIdByName(String value,
                                      String locationHint)

getSiteGroupIdByName

public static long getSiteGroupIdByName(String siteName,
                                        long company,
                                        String locationName)

substituteFileReferencesWithURL

public static String substituteFileReferencesWithURL(String content,
                                                     String locationHint,
                                                     long groupId,
                                                     long company,
                                                     long repoId,
                                                     long userId,
                                                     int refType)

Substitutes all references for documents and media files. A file reference must have the following format in BNF:
fileReference ::= "{{$FILE=" siteReference+ filePath "$}}"
siteReference ::= "::" < site-name > "::"
filePath ::= ("/" < path-segment >)*

Parameters:

content - The content of the article.

locationHint - A location hint where the substitution is done (for logging), eg., the file name of the article.

groupId - The group id (site) in which scope the article is imported.

company - The company id.

repoId - The repository id.

userId - The id of the importing user.

refType - -

Returns:

Returns the content with all substituted file references.

substituteCategoryNameWithCategoryId

public static String substituteCategoryNameWithCategoryId(String content,
                                                          String locationHint,
                                                          long groupId,
                                                          long company,
                                                          long userId)

lookupSiteIdWithName

public static String lookupSiteIdWithName(String locationHint,
                                          String value,
                                          long company)

lookupOrgOrUserGroupIdWithName

public static String lookupOrgOrUserGroupIdWithName(String locationHint,
                                                    String value,
                                                    long company,
                                                    boolean uuid,
                                                    boolean org)

lookupArticleWithArticleId

public static String lookupArticleWithArticleId(String content,
                                                String locationHint,
                                                long groupId,
                                                long company,
                                                int typeOfId)

lookupPageIdWithFriendlyUrl

public static String lookupPageIdWithFriendlyUrl(String content,
                                                 String locationHint,
                                                 long groupId,
                                                 long company,
                                                 boolean isPrivate,
                                                 IdMode mode)

lookupDDLRecordSetId

public static String lookupDDLRecordSetId(String content,
                                          String locationHint,
                                          long groupId,
                                          long company)

lookupStructureOrTemplateIdWithKey

public static String lookupStructureOrTemplateIdWithKey(String content,
                                                        String locationHint,
                                                        long groupId,
                                                        long company,
                                                        boolean uuid,
                                                        String commandPrefix,
                                                        boolean isTemplate,
                                                        Class referredClass)

getArticleByArticleID

public static com.liferay.journal.model.JournalArticle getArticleByArticleID(String articleId,
                                                                             long groupId)
                                                                      throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getStructureId

public static long getStructureId(String structureKey,
                                  long groupId,
                                  Class clazz,
                                  boolean includeAncestorStructures)
                           throws com.liferay.portal.kernel.exception.SystemException,
                                  com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.SystemException

com.liferay.portal.kernel.exception.PortalException

getStructureUUID

public static String getStructureUUID(String structureKey,
                                      long groupId,
                                      Class clazz)
                               throws com.liferay.portal.kernel.exception.SystemException,
                                      com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.SystemException

com.liferay.portal.kernel.exception.PortalException

getTemplateId

public static long getTemplateId(String templateKey,
                                 long groupId,
                                 Class clazz)
                          throws com.liferay.portal.kernel.exception.SystemException,
                                 com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.SystemException

com.liferay.portal.kernel.exception.PortalException

getOrganization

public static com.liferay.portal.kernel.model.Organization getOrganization(String name,
                                                                           long companyId,
                                                                           String locationHint)

getUserGroup

public static com.liferay.portal.kernel.model.UserGroup getUserGroup(String name,
                                                                     long companyId,
                                                                     String locationHint)

getTemplateUUID

public static String getTemplateUUID(String templateKey,
                                     long groupId)
                              throws com.liferay.portal.kernel.exception.SystemException,
                                     com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.SystemException

com.liferay.portal.kernel.exception.PortalException