org.apache.cocoon.components.blocks
Interface Block

All Superinterfaces:
Processor
All Known Implementing Classes:
BlockManager

public interface Block
extends Processor

Version:
SVN $Id: Block.java 306543 2005-10-06 06:23:36Z danielf $

Nested Class Summary
 
Nested classes inherited from class org.apache.cocoon.Processor
Processor.InternalPipelineDescription
 
Field Summary
static String NAME
           
static String SUPER
           
 
Fields inherited from interface org.apache.cocoon.Processor
ROLE
 
Method Summary
 URI absolutizeURI(URI uriToResolve, URI base)
          Takes the scheme specific part of a block URI (the scheme is the responsibilty of the BlockSource) and resolve it with respect to the blocks mount point.
 String getMountPath()
          Get the mount path of the block
 String getProperty(String name)
          Get a block property
 URI resolveURI(URI uriToResolve, URI base)
          Parses and resolves the scheme specific part of a block URI with respect to the base URI of the current sitemap.
 
Methods inherited from interface org.apache.cocoon.Processor
buildPipeline, getAttribute, getComponentConfigurations, getContext, getRootProcessor, getSourceResolver, process, removeAttribute, setAttribute
 

Field Detail

NAME

public static final String NAME

SUPER

public static final String SUPER
See Also:
Constant Field Values
Method Detail

getMountPath

public String getMountPath()
Get the mount path of the block


getProperty

public String getProperty(String name)
Get a block property


absolutizeURI

public URI absolutizeURI(URI uriToResolve,
                         URI base)
                  throws URISyntaxException
Takes the scheme specific part of a block URI (the scheme is the responsibilty of the BlockSource) and resolve it with respect to the blocks mount point.

Throws:
URISyntaxException

resolveURI

public URI resolveURI(URI uriToResolve,
                      URI base)
               throws URISyntaxException
Parses and resolves the scheme specific part of a block URI with respect to the base URI of the current sitemap. The scheme specific part of the block URI has the form foo:/bar when refering to another block, in this case only an absolute path is allowed. For reference to the own block, both absolute /bar and relative ./foo paths are allowed.

Throws:
URISyntaxException


Copyright ? 1999-2005 The Apache Software Foundation. All Rights Reserved.