• Home
• io.guise
• guise-framework
• 0.5.2
• source code
• Theme.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

io.guise.framework.theme.Theme Maven / Gradle / Ivy

/*
 * Copyright © 2005-2012 GlobalMentor, Inc. 
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.guise.framework.theme;

import java.net.URI;
import java.lang.reflect.InvocationTargetException;
import java.util.*;

import static java.util.Objects.*;

import com.globalmentor.collections.CollectionMap;
import com.globalmentor.collections.HashSetHashMap;
import com.globalmentor.net.MediaType;
import com.globalmentor.util.*;

import io.guise.framework.style.*;
import io.urf.model.UrfResourceDescription;

import static com.globalmentor.java.Classes.*;
import static io.guise.framework.Resources.*;

/**
 * Guise theme specification.
 * @author Garret Wilson
 */
public class Theme extends ArrayList /*TODO delete legacy URF extends URFListResource*/ {

	/** The extension for Guise theme resource names. */
	public static final String FILENAME_EXTENSION = "guisetheme";
	/** The media type for theme resources: application/theme+turf. */
	public static final MediaType MEDIA_TYPE = MediaType.of(MediaType.APPLICATION_PRIMARY_TYPE,
			"theme" + MediaType.SUBTYPE_SUFFIX_DELIMITER_CHAR + "turf"); //TODO TODO use constant for new TURF: TURF.SUBTYPE_SUFFIX

	/** The recommended prefix to the theme ontology namespace. */
	public static final String THEME_NAMESPACE_PREFIX = "theme";
	/** The URI to the theme ontology namespace. */
	public static final URI THEME_NAMESPACE_URI = URI.create("https://guise.io/framework/namespaces/theme/");

	//classes
	/** The URI of the template class. */
	//TODO fix for new URF: public static final URI TEMPLATE_CLASS_URI = createResourceURI(THEME_NAMESPACE_URI, getLocalName(Template.class));

	//properties
	/** The apply property name. */
	//TODO fix for new URF: public static final URI APPLY_PROPERTY_URI = createResourceURI(THEME_NAMESPACE_URI, "apply");
	/** The property for the URI of the theme's parent. */
	public static final URI PARENT_URI_PROPERTY_URI = THEME_NAMESPACE_URI.resolve("parentURI");
	/** The resources property name. */
	public static final URI RESOURCES_PROPERTY_URI = THEME_NAMESPACE_URI.resolve("resources+");

	private final UrfResourceDescription description; //TODO improve; temporary hack to get legacy Guise working

	public UrfResourceDescription getDescription() {
		return description;
	}

	/** The theme parent, or null if there is no resolving parent. */
	private Theme parent = null;

	/** @return The theme parent, or null if there is no resolving parent. */
	public Theme getParent() {
		return parent;
	}

	/**
	 * Sets the theme parent.
	 * @param newParent The new theme parent, or null if there should be no resolving parent.
	 */
	public void setParent(final Theme newParent) {
		parent = newParent;
	} //TODO maybe remove and create custom ThemeIO

	/** The map of sets of rules that have selectors selecting classes. */
	private final CollectionMap, Rule, Set> classRuleMap = new HashSetHashMap, Rule>(); //TODO make this store a sorted set, and use a comparator based on order

	/**
	 * Retrieves the set of rules that selects the class of the given object, including parent classes. It is not guaranteed that the object will match all or any
	 * of the returned rules; only that the object's class is used as part of the selections of the returned rules.
	 * @param object The object for which class-selected rules should be returned.
	 * @return A set of all rules that reference a class that selects the given object's class.
	 * @throws NullPointerException if the given object is null.
	 */
	public Set getClassRules(final Object object) {
		final Class objectClass = requireNonNull(object, "Object cannot be null").getClass(); //get the object's class
		Set combinedRuleSet = null; //we'll create the rule set only if needed
		final List> ancestorClasses = getAncestorClasses(objectClass); //get the class ancestor hierarchy of this class TODO cache these
		for(final Class ancestorClass : ancestorClasses) { //for each ancestor class TODO iterate the list in the correct order; send back the rules in the correct order
			final Set ruleSet = classRuleMap.get(ancestorClass); //try to get a rule for the object's ancestor class
			if(ruleSet != null) { //if we found a rule set
				if(combinedRuleSet == null) { //if we haven't yet created the combined rule set
					combinedRuleSet = new HashSet(); //create a new hash set
				}
				combinedRuleSet.addAll(ruleSet); //add all the rules for the ancestor class to the combined rule set
			}
		}
		return combinedRuleSet != null ? combinedRuleSet : Collections.emptySet(); //return the combined set of rules we've found (Java won't allow emptySet() to be used in this context, but a warning here is better than alternate, less-efficient methods)
	}

	//TODO delete legacy URF
	//	/** Default constructor. */
	/*TODO delete legacy URF
	public Theme() {
		this((URI)null); //construct the class with no reference URI
	}
	*/

	//TODO delete legacy URF
	//	/**
	//	 * Reference URI constructor.
	//	 * @param referenceURI The reference URI for the new resource.
	//	 */
	/*TODO delete legacy URF
	public Theme(final URI referenceURI) {
		super(referenceURI, createResourceURI(THEME_NAMESPACE_URI, getLocalName(Theme.class))); //construct the parent class, using a type based upon the name of this class
	}
	 */
	//TODO delete legacy URF
	//	/**
	//	 * Collection constructor with no URI. The elements of the specified collection will be added to this list in the order they are returned by the collection's
	//	 * iterator.
	//	 * @param collection The collection whose elements are to be placed into this list.
	//	 * @throws NullPointerException if the specified collection is null.
	//	 */
	/*TODO delete legacy URF
	public Theme(final Collection collection) {
		this(null, collection); //construct the class with no URI
	}
	 */
	//TODO delete legacy URF
	//	/**
	//	 * URI and collection constructor. The elements of the specified collection will be added to this list in the order they are returned by the collection's
	//	 * iterator.
	//	 * @param uri The URI for the resource, or null if the resource should have no URI.
	//	 * @param collection The collection whose elements are to be placed into this list.
	//	 * @throws NullPointerException if the specified collection is null.
	//	 */
	/*TODO delete legacy URF
	public Theme(final URI uri, final Collection collection) {
		this(uri); //construct the class with the URI
		addAll(collection); //add all the collection elements to the list
	}
	*/

	private final URI uri; //TODO improve; this is a short-term hack to allow loading relative paths from legacy Guise themes

	public URI getURI() {
		return uri;
	}

	/**
	 * URI and description constructor.
	 * @param uri The URI of the theme.
	 * @param description The theme description, loaded from a legacy Guise theme file.
	 */
	public Theme(final URI uri, final UrfResourceDescription description) {
		this.uri = requireNonNull(uri);
		this.description = requireNonNull(description);
	}

	/**
	 * Parent theme and description constructor.
	 * @param parent The theme to serve as the parent of this theme, or null if this theme should have no parent.
	 * @param description The theme description, loaded from a legacy Guise theme file.
	 */
	/*TODO determine if needed
	public Theme(final Theme parent, final UrfResourceDescription description) {
		this.parent = parent; //save the parent theme
		this.description = requireNonNull(description);
	}
	*/

	/**
	 * Retrieves the URI indicating the parent theme.
	 * @return The URI indicating the parent theme, or null if no parent theme is indicated or the value is not a URI.
	 */
	public URI getParentURI() {
		//TODO create utility as() method for Optional
		return getDescription().findPropertyValue(PARENT_URI_PROPERTY_URI).filter(URI.class::isInstance).map(URI.class::cast).orElse(null); //return the theme.parent property as a URI
	}

	/**
	 * Retrieves the resources URF resources. Each resource may indicate an external set of resources to load by providing a reference URI, or be a map of
	 * resource definitions.
	 * @param locale The locale of the resource to be retrieved.
	 * @return The list of resources that indicate resources locations and/or contain resource definitions.
	 */
	public Set