com.liferay.asset.display.contributor.BaseAssetDisplayContributor Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of release.portal.api Show documentation
POM was created by Sonatype Nexus
There is a newer version: 7.4.3.112-ga112
/**
 * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 */

package com.liferay.asset.display.contributor;

import com.liferay.asset.kernel.AssetRendererFactoryRegistryUtil;
import com.liferay.asset.kernel.model.AssetEntry;
import com.liferay.asset.kernel.model.AssetRenderer;
import com.liferay.asset.kernel.model.AssetRendererFactory;
import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.language.LanguageUtil;
import com.liferay.portal.kernel.security.permission.ResourceActionsUtil;
import com.liferay.portal.kernel.util.ResourceBundleLoader;
import com.liferay.portal.kernel.util.ResourceBundleUtil;

import java.util.HashMap;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.ResourceBundle;
import java.util.Set;

import org.osgi.framework.Bundle;
import org.osgi.framework.FrameworkUtil;

/**
 * @author Jürgen Kappler
 */
public abstract class BaseAssetDisplayContributor
	implements AssetDisplayContributor {

	@Override
	public Set getAssetDisplayFields(
			long classTypeId, Locale locale)
		throws PortalException {

		Set assetDisplayFields = new LinkedHashSet<>();

		ResourceBundle resourceBundle = getResourceBundle(locale);

		// Default fields for asset entry

		for (Map.Entry assetEntryModelField :
				_assetEntryModelFieldsMap.entrySet()) {

			assetDisplayFields.add(
				new AssetDisplayField(
					assetEntryModelField.getKey(),
					LanguageUtil.get(
						resourceBundle, assetEntryModelField.getValue())));
		}

		// Fields for the specific asset type

		String[] assetEntryModelFields = getAssetEntryModelFields();

		if (assetEntryModelFields != null) {
			for (String assetEntryModelField : assetEntryModelFields) {
				assetDisplayFields.add(
					new AssetDisplayField(
						assetEntryModelField,
						LanguageUtil.get(
							resourceBundle, assetEntryModelField)));
			}
		}

		// Fields for the class type

		List classTypeFields = getClassTypeFields(
			classTypeId, locale);

		assetDisplayFields.addAll(classTypeFields);

		return assetDisplayFields;
	}

	@Override
	public Map getAssetDisplayFieldsValues(
			AssetEntry assetEntry, Locale locale)
		throws PortalException {

		// Default fields for asset entry

		Map parameterMap = _getDefaultParameterMap(
			assetEntry, locale);

		// Fields for the specific asset type

		AssetRendererFactory assetRendererFactory =
			AssetRendererFactoryRegistryUtil.
				getAssetRendererFactoryByClassNameId(
					assetEntry.getClassNameId());

		AssetRenderer assetRenderer = assetRendererFactory.getAssetRenderer(
			assetEntry.getClassPK());

		String[] assetEntryModelFields = getAssetEntryModelFields();

		if (assetEntryModelFields != null) {
			for (String assetEntryModelField : assetEntryModelFields) {
				parameterMap.put(
					assetEntryModelField,
					getFieldValue(
						assetRenderer.getAssetObject(), assetEntryModelField,
						locale));
			}
		}

		// Fields for the class type

		Map classTypeValues = getClassTypeValues(
			assetRenderer.getAssetObject(), locale);

		parameterMap.putAll(classTypeValues);

		return parameterMap;
	}

	@Override
	public String getLabel(Locale locale) {
		return ResourceActionsUtil.getModelResource(locale, getClassName());
	}

	protected abstract String[] getAssetEntryModelFields();

	protected abstract Map getClassTypeValues(
		T assetEntryObject, Locale locale);

	protected abstract Object getFieldValue(
		T assetEntryObject, String field, Locale locale);

	protected ResourceBundle getResourceBundle(Locale locale) {
		if (resourceBundleLoader == null) {
			Bundle bundle = FrameworkUtil.getBundle(getClass());

			return ResourceBundleUtil.getBundle(
				locale, bundle.getSymbolicName());
		}

		return resourceBundleLoader.loadResourceBundle(locale);
	}

	/**
	 * @deprecated As of Judson (7.1.x), replaced with {@link
	 *             #getResourceBundle(Locale)}
	 */
	@Deprecated
	protected void setResourceBundleLoader(
		ResourceBundleLoader resourceBundleLoader) {

		this.resourceBundleLoader = resourceBundleLoader;
	}

	protected ResourceBundleLoader resourceBundleLoader;

	private Map _getDefaultParameterMap(
		AssetEntry assetEntry, Locale locale) {

		Map parameterMap = new HashMap<>();

		parameterMap.put("categoryIds", assetEntry.getCategoryIds());
		parameterMap.put("description", assetEntry.getDescription(locale));
		parameterMap.put("publishDate", assetEntry.getPublishDate());
		parameterMap.put("summary", assetEntry.getSummary(locale));
		parameterMap.put("tagNames", assetEntry.getTagNames());
		parameterMap.put("title", assetEntry.getTitle(locale));

		return parameterMap;
	}

	private static final Map _assetEntryModelFieldsMap =
		new HashMap() {
			{
				put("categoryIds", "categories");
				put("description", "description");
				put("publishDate", "publish-date");
				put("summary", "summary");
				put("tagNames", "tags");
				put("title", "title");
			}
		};

}