org.jahia.services.render

Class BaseView

java.lang.Object

org.jahia.services.render.BaseView

All Implemented Interfaces:

Comparable<View>, View

Direct Known Subclasses:

BundleView

public abstract class BaseView
extends Object
implements View, Comparable<View>

Base class for resources views.

Author:

Sergiy Shyrkov

Field Summary

Fields inherited from interface org.jahia.services.render.View

DEFAULT_VIEW_KEY, TYPE_KEY, VISIBLE_FALSE, VISIBLE_KEY, VISIBLE_STUDIO_ONLY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseView(String path, String key, JahiaTemplatesPackage module) Initializes an instance of this class.
protected	BaseView(String path, String key, JahiaTemplatesPackage module, String displayName) Initializes an instance of this class.

Method Summary

Modifier and Type	Method and Description
int	compareTo(View otherView)
boolean	equals(Object o)
Properties	getDefaultProperties() Return default properties of the node type template
String	getDisplayName()
String	getFileExtension()
String	getInfo() Return printable information about the script : type, localization, file, ..
protected abstract InputStream	getInputStream(String resource) Returns an input stream for the specified resource or null if the resource does not exist.
String	getKey()
JahiaTemplatesPackage	getModule()
String	getModuleVersion()
String	getPath()
Properties	getProperties() Return properties of the template
protected abstract URL	getResource(String resource)
protected abstract String	getResourcePath(String resource) Obtains the path for the specified resource which can be used to read it using corresponding script, e.g.
int	hashCode()
protected Properties	loadProperties(String path, String thumbnailPath)
void	setDefaultProperties(Properties defaultProperties)
void	setProperties(Properties properties)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BaseView

protected BaseView(String path,
                   String key,
                   JahiaTemplatesPackage module)

Initializes an instance of this class.

Parameters:

path - the resource path

key - the key of the view

module - corresponding JahiaTemplatesPackage instance

BaseView

protected BaseView(String path,
                   String key,
                   JahiaTemplatesPackage module,
                   String displayName)

Initializes an instance of this class.

Parameters:

path - the resource path

key - the key of the view

module - corresponding JahiaTemplatesPackage instance

displayName - the display name for this view

Method Detail

compareTo

public int compareTo(View otherView)

Specified by:

compareTo in interface Comparable<View>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getDefaultProperties

public Properties getDefaultProperties()

Description copied from interface: View

Return default properties of the node type template

Specified by:

getDefaultProperties in interface View

Returns:

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface View

getFileExtension

public String getFileExtension()

Specified by:

getFileExtension in interface View

getInfo

public String getInfo()

Description copied from interface: View

Return printable information about the script : type, localization, file, .. in order to help template developer to find the original source of the script

Specified by:

getInfo in interface View

Returns:

printable information about the script : type, localization, file, .. in order to help template developer to find the original source of the script

getInputStream

protected abstract InputStream getInputStream(String resource)
                                       throws IOException

Returns an input stream for the specified resource or null if the resource does not exist.

Parameters:

resource - the resource path to obtain input stream for

Returns:

an input stream for the specified resource or null if the resource does not exist

Throws:

IOException - in case of an I/O errors

getKey

public String getKey()

Specified by:

getKey in interface View

getModule

public JahiaTemplatesPackage getModule()

Specified by:

getModule in interface View

getModuleVersion

public String getModuleVersion()

Specified by:

getModuleVersion in interface View

getPath

public String getPath()

Specified by:

getPath in interface View

getProperties

public Properties getProperties()

Description copied from interface: View

Return properties of the template

Specified by:

getProperties in interface View

Returns:

properties of the template

getResource

protected abstract URL getResource(String resource)

getResourcePath

protected abstract String getResourcePath(String resource)

Obtains the path for the specified resource which can be used to read it using corresponding script, e.g. request dispatcher. If the resource does not exist, return null.

Parameters:

resource - the resource to get the path for

Returns:

the path for the specified resource which can be used to read it using corresponding script, e.g. request dispatcher. If the resource does not exist, return null

hashCode

public int hashCode()

Overrides:

hashCode in class Object

loadProperties

protected Properties loadProperties(String path,
                                    String thumbnailPath)

setProperties

public void setProperties(Properties properties)

setDefaultProperties

public void setDefaultProperties(Properties defaultProperties)

toString

public String toString()

Overrides:

toString in class Object