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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of guise-framework Show documentation
Guise™ Internet application framework.
There is a newer version: 0.5.3
/*
 * Copyright © 2005-2008 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.lang.reflect.InvocationTargetException;
import java.net.URI;

import com.globalmentor.util.DataException;

import static com.globalmentor.java.Objects.*;
import static io.guise.framework.theme.Theme.*;

/**
 * A rule for specifying part of a theme.
 * @author Garret Wilson
 */
public class Rule /*TODO fix for new URF: extends AbstractClassTypedURFResource*/ {

	/** Default constructor. */
	public Rule() {
		this(null); //construct the class with no reference URI
	}

	/**
	 * Reference URI constructor.
	 * @param referenceURI The reference URI for the new resource.
	 */
	public Rule(final URI referenceURI) {
		//TODO fix for new URF: super(referenceURI, THEME_NAMESPACE_URI); //construct the parent class
	}

	/**
	 * Return this rule's selector, or null if this rule has no selector property or the value is not a {@link Selector}.
	 * @return This rule's selector, or null if this rule has no selector property or the value is not a {@link Selector}.
	 * @see Select#SELECTOR_PROPERTY_URI
	 */
	/*TODO fix for new URF
	public Selector getSelector() {
		return asInstance(getPropertyValue(SELECTOR_PROPERTY_URI), Selector.class).orElse(null); //return the select.selector value TODO propagate Optional
	}
	*/

	/**
	 * Sets this rule's selector.
	 * @param selector This rule's selector, or null if this rule should have no selector property.
	 */
	/*TODO fix for new URF
	public void setSelector(final Selector selector) {
		setPropertyValue(SELECTOR_PROPERTY_URI, selector); //set the select.select property
	}
	*/

	/** @return This rule's apply declaration, or null if this rule has no theme.apply selector or the value is not a {@link Template}. */
	public Template getApply() {
		throw new UnsupportedOperationException();
		//TODO fix for new URF: return asInstance(getPropertyValue(APPLY_PROPERTY_URI), Template.class); //return the theme.apply value if it is a Template
	}

	/**
	 * Sets this rule's apply declaration.
	 * @param apply This rule's apply declaration, or null if this rule should have no apply declaration.
	 */
	public void setApply(final Template apply) {
		throw new UnsupportedOperationException();
		//TODO fix for new URF: setPropertyValue(APPLY_PROPERTY_URI, apply); //set the theme.apply property
	}

	/**
	 * Applies this rule to the given object. Providing a PLOOP processor allows consistency of referenced values across rule applications.
	 * @param object The object on which this rule should be applied.
	 * @param ploopProcessor The PLOOP processor for setting object properties.
	 * @return true if the rule selected the given object.
	 * @throws NullPointerException if the given object and/or PLOOP processor is null.
	 * @throws DataException if a resource is a Java-typed resource the class of which cannot be found.
	 * @throws DataException if a particular value is not an appropriate argument for the corresponding property.
	 * @throws DataException If a particular property could not be accessed.
	 * @throws InvocationTargetException if a resource indicates a Java class the constructor of which throws an exception.
	 */
	/*TODO fix for new URF 
	public boolean apply(final Object object, final PLOOPURFProcessor ploopProcessor) throws DataException, InvocationTargetException {
		final Selector selector = getSelector(); //get the selector, if any
		if(selector != null && selector.selects(object)) { //if this selector selects the object
			final Template template = getApply(); //get the template to apply, if any
			if(template != null) { //if there is a template
				template.apply(object, ploopProcessor); //apply the template to the object
			}
			return true; //indicate that the rule applied to the object
		}
		return false; //indicate that the rule didn't apply to the object
	}
	*/

}