ucar.unidata.idv.publish
Class IdvPublisher

java.lang.Object
  extended by ucar.unidata.idv.publish.IdvPublisher
All Implemented Interfaces:
Cloneable

public abstract class IdvPublisher
extends Object
implements Cloneable

This is the start to an abstract base class that represents classes that can "publish" IDV content. Note: This framework is very much in flux

Right no we just have a single concrete derived class, InfoceteraBlogger, that publishes weblog content to an Infocetera web log.

The idea is that we might a variety of publishing mechanisms: other weblog clients, email, wiki, etc.

Instances of publishers are defined by the resources/publishers.xml file.

Author:
IDV development team

Constructor Summary
  IdvPublisher()
           
protected IdvPublisher(IntegratedDataViewer idv, Element element)
          Construct the object with the reference to the idv
 
Method Summary
 IdvPublisher cloneMe()
           
 void configure()
           
 boolean configurexxx()
           
 boolean doInitNew()
           
 void doPublish()
           
 IntegratedDataViewer getIdv()
           
 boolean getLocal()
          Get the Local property.
 String getName()
          Get the Name property.
abstract  String getTypeName()
          Get the name of this publisher
protected  void init()
          Initialize this publisher.
 void initMenu(JMenu menu)
           
 void publishContent(String file, ViewManager fromViewmanager)
           
 void publishIslImage(Element tag, Image image)
           
protected  void setIdv(IntegratedDataViewer idv)
           
 void setLocal(boolean value)
          Set the Local property.
 void setName(String value)
          Set the Name property.
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IdvPublisher

public IdvPublisher()

IdvPublisher

protected IdvPublisher(IntegratedDataViewer idv,
                       Element element)
Construct the object with the reference to the idv

Parameters:
idv - Reference to the idv
element - The xml element that defined this publisher
Method Detail

cloneMe

public IdvPublisher cloneMe()
                     throws CloneNotSupportedException
Throws:
CloneNotSupportedException

getIdv

public IntegratedDataViewer getIdv()

setIdv

protected void setIdv(IntegratedDataViewer idv)

doInitNew

public boolean doInitNew()

initMenu

public void initMenu(JMenu menu)

publishIslImage

public void publishIslImage(Element tag,
                            Image image)

doPublish

public void doPublish()

publishContent

public void publishContent(String file,
                           ViewManager fromViewmanager)

init

protected void init()
Initialize this publisher. A hook so derived classes can get initialized


getTypeName

public abstract String getTypeName()
Get the name of this publisher

Returns:
The name

configurexxx

public boolean configurexxx()

configure

public void configure()

setName

public void setName(String value)
Set the Name property.

Parameters:
value - The new value for Name

getName

public String getName()
Get the Name property.

Returns:
The Name

toString

public String toString()
Overrides:
toString in class Object

setLocal

public void setLocal(boolean value)
Set the Local property.

Parameters:
value - The new value for Local

getLocal

public boolean getLocal()
Get the Local property.

Returns:
The Local