oqube.muse
Interface MuseLinker

All Known Implementing Classes:

MuseAnchorLinker

public interface MuseLinker

An interface for publishing links. This interface is used by MuseSink instances to process link references and publish them. Instances of this interface are processed in a *Chain of responsibility* pattern: an instance that knows how to handle a link should return a non-null result. Implementations of this interface should declare themselves as plexus components with an additional *hint* specifying which kind of rendering format they provide (ie. latex, xhtml, pdf, whatever). This hint will be used in wiring linkers to sinks.

Version:

$Id$

Author:

abailly@oqube.muse.com

Field Summary

static java.lang.String

ROLE

Method Summary

void	anchor(MuseSink sink, java.lang.String anchor) Generates an anchor that may later be used as a target for links.
void	link(MuseSink sink, java.lang.String link, java.lang.String text) Generate a publication ready link for given link and text couple.

Field Detail

ROLE

static final java.lang.String ROLE

Method Detail

link

void link(MuseSink sink,
          java.lang.String link,
          java.lang.String text)

Generate a publication ready link for given link and text couple.

Parameters:

sink - thi sink where data is published to

link - the target of the link

text - the anchor of the link

anchor

void anchor(MuseSink sink,
            java.lang.String anchor)

Generates an anchor that may later be used as a target for links. Depending on the sink, this may ar may not produce output.

Parameters:

sink - thi sink where data is published to

anchor - the identifier of the anchor