Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

com.obinary.cms.beans
Class TemplateInfo  view TemplateInfo download TemplateInfo.java

java.lang.Object
  extended bycom.obinary.cms.beans.TemplateInfo

public class TemplateInfo
extends java.lang.Object

User: sameercharles Date: Apr 28, 2003 Time: 11:20:59 AM

Version:
1.0

Field Summary
static int ADMIN_TEMPLATES
           
private static java.util.Iterator adminTemplates
           
private  java.util.Hashtable alternativePaths
           
private static java.util.Hashtable cachedContent
           
static int CUSTOM_TEMPLATES
           
private  java.lang.String description
          Optional fields
private  java.lang.String image
           
private  java.lang.String name
          Mandataory
private  java.lang.String path
          Mandataory
private static java.lang.String START_PAGE
           
private static java.util.Iterator templates
           
private  java.lang.String title
           
private  java.lang.String type
          Mandataory
private  boolean visible
          Mandataory
private static java.util.ArrayList visibleAdminTemplates
           
private static java.util.ArrayList visibleTemplates
           
 
Constructor Summary
TemplateInfo()
          constructor
TemplateInfo(boolean initialize)
          constructor
 
Method Summary
private static void addAlternativePaths(com.obinary.cms.core.Container container, TemplateInfo ti)
          add alternative extention paths to templates cache
private static void addTemplatesToCache(java.util.Iterator templates, java.util.ArrayList visibleTemplates)
          adds templates definition to TemplatesInfo cache
private static void cacheContent()
          load content of this template info page in a hash table caching at the system load, this will save lot of time on every request while matching template info
static java.util.Iterator getAvailableTemplates(int type)
          get templates collection
 java.lang.String getDescription()
           
 java.lang.String getImage()
           
static TemplateInfo getInfo(java.lang.String key)
          returns the cached content of the requested template
TemplateInfo properties :
1.
 java.lang.String getName()
           
 java.lang.String getPath()
           
 java.lang.String getPath(java.lang.String extension)
           
 java.lang.String getTitle()
           
 java.lang.String getType()
           
static void init()
          load all temple definitions available as a collection of Content objects
 boolean isVisible()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

START_PAGE

private static final java.lang.String START_PAGE
See Also:
Constant Field Values

CUSTOM_TEMPLATES

public static final int CUSTOM_TEMPLATES
See Also:
Constant Field Values

ADMIN_TEMPLATES

public static final int ADMIN_TEMPLATES
See Also:
Constant Field Values

templates

private static java.util.Iterator templates

adminTemplates

private static java.util.Iterator adminTemplates

visibleTemplates

private static java.util.ArrayList visibleTemplates

visibleAdminTemplates

private static java.util.ArrayList visibleAdminTemplates

cachedContent

private static java.util.Hashtable cachedContent

name

private java.lang.String name
Mandataory


path

private java.lang.String path
Mandataory


alternativePaths

private java.util.Hashtable alternativePaths

type

private java.lang.String type
Mandataory


visible

private boolean visible
Mandataory


description

private java.lang.String description
Optional fields


image

private java.lang.String image

title

private java.lang.String title
Constructor Detail

TemplateInfo

public TemplateInfo()
constructor


TemplateInfo

public TemplateInfo(boolean initialize)
             throws ElementNotFoundException,
                    RepositoryException
constructor

Method Detail

init

public static void init()
                 throws ElementNotFoundException,
                        RepositoryException

load all temple definitions available as a collection of Content objects


getAvailableTemplates

public static java.util.Iterator getAvailableTemplates(int type)

get templates collection


cacheContent

private static void cacheContent()

load content of this template info page in a hash table caching at the system load, this will save lot of time on every request while matching template info


addTemplatesToCache

private static void addTemplatesToCache(java.util.Iterator templates,
                                        java.util.ArrayList visibleTemplates)

adds templates definition to TemplatesInfo cache


addAlternativePaths

private static void addAlternativePaths(com.obinary.cms.core.Container container,
                                        TemplateInfo ti)

add alternative extention paths to templates cache


getInfo

public static TemplateInfo getInfo(java.lang.String key)
                            throws java.lang.Exception

returns the cached content of the requested template
TemplateInfo properties :
1. title - title describing template
2. type - jsp / servlet
3. path - jsp / servlet path
4. description - description of a template


getName

public java.lang.String getName()

getTitle

public java.lang.String getTitle()

getDescription

public java.lang.String getDescription()

getPath

public java.lang.String getPath()

getPath

public java.lang.String getPath(java.lang.String extension)

getType

public java.lang.String getType()

getImage

public java.lang.String getImage()

isVisible

public boolean isVisible()