org.apache.wsil
Class WSILDocument

java.lang.Object
  extended by org.apache.wsil.WSILDocument
Direct Known Subclasses:
WSILDocumentImpl

public abstract class WSILDocument
extends java.lang.Object

Instance of a WS-Inspection document.

Version:
1.0
Author:
Peter Brittenham

Field Summary
protected  DocumentReader docReader
          Set default document reader.
protected  java.lang.String documentURL
          WSIL document URL.
protected  DocumentWriter docWriter
          Set default document writer.
protected  ExtensionRegistry extRegistry
          WS-Inspection extension registry.
protected  Inspection inspection
          Inspection element.
 
Constructor Summary
WSILDocument()
           
 
Method Summary
abstract  Abstract createAbstract()
          Create abstract element.
abstract  Description createDescription()
          Create description element.
abstract  Link createLink()
          Create link element.
abstract  Service createService()
          Create service element.
abstract  ServiceName createServiceName()
          Create service name element.
 ExtensionRegistry getExtensionRegistry()
          Get the WS-Inspection extension registry implementation.
 Inspection getInspection()
          Get the inspection element for this document.
 DocumentReader getReader()
          Get the WS-Inspection reader implementation.
 DocumentWriter getWriter()
          Get the WS-Inspection writer implementation.
static void main(java.lang.String[] args)
          Read a WS-Inspection document and display its contents.
static WSILDocument newInstance()
           
 void read(java.io.Reader reader)
          Read the WS-Inspection document from a input reader.
 void read(java.lang.String urlString)
          Read the WS-Inspection document from a file URL string.
 void read(java.net.URL url)
          Read the WS-Inspection document from a location specified using a URL.
 java.lang.String resolveURL(java.lang.String relativeURL)
          This method is used to resolve a relative URL into a full URL.
 void setDocumentURL(java.lang.String documentURL)
          Set the location for the WS-Inspection document.
 void setExtensionRegistry(ExtensionRegistry extRegistry)
          Set the WS-Inspection extension registry implementation.
 void setReader(DocumentReader docReader)
          Set the WS-Inspection reader implementation.
 void setWriter(DocumentWriter docWriter)
          Set the WS-Inspection writer implementation.
 java.lang.String toString()
          Return string representation of this object.
 void write(java.lang.String filename)
          Write the WS-Inspection document to an output file.
 void write(java.io.Writer writer)
          Write the WS-Inpsection document to an output writer.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

docReader

protected DocumentReader docReader
Set default document reader.


docWriter

protected DocumentWriter docWriter
Set default document writer.


extRegistry

protected ExtensionRegistry extRegistry
WS-Inspection extension registry.


inspection

protected Inspection inspection
Inspection element.


documentURL

protected java.lang.String documentURL
WSIL document URL. NOTE: This field will not be set when the document is read from a Reader.

Constructor Detail

WSILDocument

public WSILDocument()
Method Detail

createAbstract

public abstract Abstract createAbstract()
Create abstract element.

Returns:
Returns an abstract object.

createDescription

public abstract Description createDescription()
Create description element.

Returns:
Returns a description object.

createLink

public abstract Link createLink()
Create link element.

Returns:
Returns a link object.

createService

public abstract Service createService()
Create service element.

Returns:
Returns a service object.

createServiceName

public abstract ServiceName createServiceName()
Create service name element.

Returns:
Returns a serviceName object.

getExtensionRegistry

public ExtensionRegistry getExtensionRegistry()
Get the WS-Inspection extension registry implementation.

Parameters:
Returns - a reference to the extension registry.

getInspection

public Inspection getInspection()
Get the inspection element for this document.

Returns:
Returns a reference to the inspection element.

getReader

public DocumentReader getReader()
Get the WS-Inspection reader implementation.

Returns:
Returns the document reader.

getWriter

public DocumentWriter getWriter()
Get the WS-Inspection writer implementation.

Returns:
Returns the document writer.

main

public static void main(java.lang.String[] args)
Read a WS-Inspection document and display its contents.

Parameters:
args - command line arguments

newInstance

public static WSILDocument newInstance()
                                throws WSILException
Throws:
WSILException

read

public void read(java.io.Reader reader)
          throws WSILException
Read the WS-Inspection document from a input reader.

Parameters:
reader - the input reader
Throws:
WSILException

read

public void read(java.lang.String urlString)
          throws WSILException
Read the WS-Inspection document from a file URL string.

Parameters:
urlString - the file URL string for the WS-Inspection document
Throws:
WSILException

read

public void read(java.net.URL url)
          throws WSILException
Read the WS-Inspection document from a location specified using a URL.

Parameters:
url - location of the document
Throws:
WSILException

setExtensionRegistry

public void setExtensionRegistry(ExtensionRegistry extRegistry)
                          throws WSILException
Set the WS-Inspection extension registry implementation.

Parameters:
extRegistry - the extension registry implementation
Throws:
WSILException

setReader

public void setReader(DocumentReader docReader)
Set the WS-Inspection reader implementation.

Parameters:
docReader - the WS-Inpsection document reader

setWriter

public void setWriter(DocumentWriter docWriter)
Set the WS-Inspection writer implementation.

Parameters:
docWriter - the WS-Inpsection document writer

toString

public java.lang.String toString()
Return string representation of this object.

Overrides:
toString in class java.lang.Object
Returns:
Returns the string representation of this object.

write

public void write(java.io.Writer writer)
           throws WSILException
Write the WS-Inpsection document to an output writer.

Parameters:
writer - the output writer
Throws:
WSILException

write

public void write(java.lang.String filename)
           throws WSILException
Write the WS-Inspection document to an output file.

Parameters:
filename - the filename for the WS-Inspection document
Throws:
WSILException

resolveURL

public java.lang.String resolveURL(java.lang.String relativeURL)
This method is used to resolve a relative URL into a full URL.

Parameters:
relativeURL - the relative URL value
Returns:
Returns the full URL.

setDocumentURL

public void setDocumentURL(java.lang.String documentURL)
Set the location for the WS-Inspection document.

Parameters:
documentURL - the document URL


Copyright ? 2001 International Business Machines Corporation. All Rights Reserved.