org.gramar.ITemplatingExtension Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gramar Show documentation

A lightweght, pure-Java component that makes composite software architecture design patterns extremely consumable through code generation.

The newest version!

package org.gramar;

import javax.xml.xpath.XPathFunction;

import org.gramar.exception.NoSuchCustomTagException;
import org.gramar.exception.NoSuchFileStoreException;
import org.gramar.exception.NoSuchModelAdaptorException;
import org.gramar.extension.DefinedTag;

/**
 * Represents an object that extends the templating platform with tag handlers and/or
 * XPath functions.  Platform extensions can be deployed in many ways and each deployment
 * method requires an implementation of ITemplatingExtension to answer the extending tag
 * handlers and XPath functions.
 * 
 * @author chrisgerken
 *
 */
public interface ITemplatingExtension {

	/*
	 * Return the default prefix to use if one is not specified
	 */
	public String getDefaultAbbreviation();
	
	/*
	 * Return the unique extension ID, a single string in the 
	 * form of a valid java package name
	 */
	public String getExtensionId();
	
	public XPathFunction getFunction(String name, int arity);

	public DefinedTag getTagDef(String tagName) throws NoSuchCustomTagException;
	
	public ITagHandler getCustomTagHandler(String tagName) throws NoSuchCustomTagException;

	public boolean hasCustomTagHandler(String tagName);
	
	public Class loadClass(String fullyQualifiedName) throws ClassNotFoundException, Exception;
	
	/** 
	 * Returns the IFileStore implementation for the given ID.  If no such filestore is 
	 * supported by this extension then throw an exception
	 * 
	 * @param fileStoreId
	 * @return an IFileStore implementation
	 * @throws NoSuchFileStoreException 
	 */
	public IFileStore getFileStore(String fileStoreId) throws NoSuchFileStoreException;
	
	/**
	 * Returns the IModelAdaptor implementation for the given adaptor ID.  If no such model adaptor
	 * is supported by this extension then throw an exception
	 * 
	 * @param adaptorID
	 * @return an IModelAdaptor implementation
	 * @throws NoSuchModelAdaptorException
	 */
	public IModelAdaptor getModelAdaptor(String adaptorID) throws NoSuchModelAdaptorException;
	
	/**
	 * Returns the IModelAdaptor implementation appropriate for convering the specified source type.  
	 * If no such model adaptor is supported by this extension then throw an exception
	 * 
	 * @param model source type (e.g. "xml" or "csv")
	 * @return an IModelAdaptor implementation
	 * @throws NoSuchModelAdaptorException
	 */
	public IModelAdaptor getModelAdaptorFor(String type) throws NoSuchModelAdaptorException;
	
}