Project JXTA

net.jxta.protocol
Class PipeAdvertisement

java.lang.Object
  extended by net.jxta.document.Advertisement
      extended by net.jxta.document.ExtendableAdvertisement
          extended by net.jxta.protocol.PipeAdvertisement
All Implemented Interfaces:
Cloneable

public abstract class PipeAdvertisement
extends ExtendableAdvertisement
implements Cloneable

This class defines the PipeServiceImpl Advertisement.

The default behavior of this abstract class is to simple be a place holder for the Pipe Id and its name.

Note that other tags can be provided by the application for its own profit. Those extra tags are not interpreted by the PipeService.


Field Summary
static String descTag
          XML tag to store the name of the Pipe
static String IdTag
          XML tag to store the PipeID
static String NameTag
          XML tag to store the name of the Pipe
static String TypeTag
          XML tag to store the Pipe Type
 
Constructor Summary
PipeAdvertisement()
           
 
Method Summary
 Object clone()
          Clone this PipeAdvertisement
static String getAdvertisementType()
          Returns the identifying type of this Advertisement.
 String getBaseAdvType()
          Returns the base type of this advertisement hierarchy.
 StructuredDocument getDesc()
          returns the description
 String getDescription()
          returns the description
 ID getID()
          get an ID for indexing purposes.
 String getName()
          get the symbolic name associated with the pipe
 ID getPipeID()
          get the pipe id
 String getType()
          get the pipe type
 void setDesc(Element desc)
          sets the description
 void setDescription(String description)
          sets the description
 void setName(String n)
          set the symbolic name associated with the pipe
 void setPipeID(ID pipeId)
          set the pipe Id
 void setType(String type)
          set the pipe type
 
Methods inherited from class net.jxta.document.ExtendableAdvertisement
getDocument, handleElement
 
Methods inherited from class net.jxta.document.Advertisement
getAdvType, getIndexFields, toString
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

IdTag

public static final String IdTag
XML tag to store the PipeID

See Also:
Constant Field Values

TypeTag

public static final String TypeTag
XML tag to store the Pipe Type

See Also:
Constant Field Values

NameTag

public static final String NameTag
XML tag to store the name of the Pipe

See Also:
Constant Field Values

descTag

public static final String descTag
XML tag to store the name of the Pipe

See Also:
Constant Field Values
Constructor Detail

PipeAdvertisement

public PipeAdvertisement()
Method Detail

getAdvertisementType

public static String getAdvertisementType()
Returns the identifying type of this Advertisement.

Returns:
String the type of advertisement

getBaseAdvType

public final String getBaseAdvType()
Returns the base type of this advertisement hierarchy. Typically, only the most basic advertisement of a type will implement this method and declare it as final.

Specified by:
getBaseAdvType in class ExtendableAdvertisement
Returns:
String the base type of advertisements in this hierarchy.

clone

public Object clone()
Clone this PipeAdvertisement

Overrides:
clone in class Advertisement
Returns:
Object an object of class PipeAdvertisement that is a deep-enough copy of this one.

getID

public ID getID()
get an ID for indexing purposes. The PipeID uniquely identifies this ADV.

Specified by:
getID in class Advertisement
Returns:
ID The Pipe ID itself.

getPipeID

public ID getPipeID()
get the pipe id

Returns:
ID PipeServiceImpl id

setPipeID

public void setPipeID(ID pipeId)
set the pipe Id

Parameters:
pipeId - The PipeId to be set.

getType

public String getType()
get the pipe type

Returns:
String PipeService type

setType

public void setType(String type)
set the pipe type

Parameters:
type - The type to be set.

getName

public String getName()
get the symbolic name associated with the pipe

Returns:
String the name field.

setName

public void setName(String n)
set the symbolic name associated with the pipe

Parameters:
n - the name this pipe adv should have.

getDescription

public String getDescription()
returns the description

Returns:
String the description

setDescription

public void setDescription(String description)
sets the description

Parameters:
description - the description

getDesc

public StructuredDocument getDesc()
returns the description

Returns:
the description

setDesc

public void setDesc(Element desc)
sets the description

Parameters:
desc - the description

JXTA J2SE