org.apache.cocoon.forms.formmodel.library
Class Library

java.lang.Object
  extended byorg.apache.cocoon.forms.formmodel.library.Library

public class Library
extends Object

Form model library.

Version:
$Id: Library.html 1304280 2012-03-23 11:18:01Z ilgrosso $

Nested Class Summary
protected  class Library.Dependency
          Encapsulates a uri to designate an import plus a timestamp so previously reloaded
 
Field Summary
protected  Map definitions
           
protected  Map inclusions
           
protected  LibraryManager manager
           
static String SEPARATOR
           
protected  Object shared
           
protected  String sourceURI
           
protected  Map widgetDefinitionBuilders
           
 
Constructor Summary
Library(LibraryManager lm, Map builders)
           
 
Method Summary
 void addDefinition(WidgetDefinition definition)
           
 void buildLibrary(Element libraryElement)
           
 boolean dependenciesHaveChanged()
           
 WidgetDefinition getDefinition(String key)
           
 String getSourceURI()
           
 boolean includeAs(String key, String sourceURI)
          "Registers" a library to be referenced later under a certain key or prefix.
 void setSourceURI(String uri)
           
 void setWidgetDefinitionBuilderSelector(Map widgetDefinitionBuilderSelector)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SEPARATOR

public static final String SEPARATOR
See Also:
Constant Field Values

widgetDefinitionBuilders

protected Map widgetDefinitionBuilders

manager

protected LibraryManager manager

definitions

protected Map definitions

inclusions

protected Map inclusions

shared

protected final Object shared

sourceURI

protected String sourceURI
Constructor Detail

Library

public Library(LibraryManager lm,
               Map builders)
Method Detail

setSourceURI

public void setSourceURI(String uri)

getSourceURI

public String getSourceURI()

dependenciesHaveChanged

public boolean dependenciesHaveChanged()
                                throws LibraryException
Throws:
LibraryException

includeAs

public boolean includeAs(String key,
                         String sourceURI)
                  throws LibraryException
"Registers" a library to be referenced later under a certain key or prefix. Definitions will be accessible locally through prefixing: "prefix:definitionid"

Parameters:
key - the key
sourceURI - the source of the library to be know as "key"
Returns:
true if there was no such key used before, false otherwise
Throws:
LibraryException - if unable to load included library

getDefinition

public WidgetDefinition getDefinition(String key)
                               throws LibraryException
Throws:
LibraryException

buildLibrary

public void buildLibrary(Element libraryElement)
                  throws Exception
Throws:
Exception

addDefinition

public void addDefinition(WidgetDefinition definition)
                   throws LibraryException
Throws:
LibraryException

setWidgetDefinitionBuilderSelector

public void setWidgetDefinitionBuilderSelector(Map widgetDefinitionBuilderSelector)


Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.