com.sapportals.wcm.protocol.ice.protocol.response

Class ICEEventLog

java.lang.Object
  com.sapportals.wcm.protocol.ice.protocol.response.ICEEventLog

All Implemented Interfaces:

IICEElementHandler, IICEElement, IDOMStorable

public class ICEEventLog
extends Object
implements IICEElement, IICEElementHandler, IDOMStorable

ICEEventLog represents an ice-event-log element.

Detailed information about ICE event log could be found in the ICE 1.1 specification Section 6.3.

ice-event-log format

 <!ELEMENT ice-event-log         ((ice-event-msg |
                                   ice-event-info)*) >
 <!ATTLIST ice-event-log
           version               CDATA           #REQUIRED
 >

See Also:

Copyright 2004 SAP AG

Field Summary

static String

TAGNAME

Constructor Summary

ICEEventLog(Attributes attributes)
Create a new ICE event log.

ICEEventLog(String version, Collection log)
Create a new ICE event log.

Method Summary

boolean	endElement(String name) Receive notification of the end of an element.
Collection	getLog() Get the event log.
IICECharacterHandler	startElement(String name, Attributes attributes, PreparsedXML input) Receive notification of the beginning of an element.
Node	store(Document document) Store the informations into a DOM.
void	write(ContentHandler handler) Write the XML representation of the ICE element to a SAX ContentHandler.
boolean	writeChunk(ContentHandler handler) Write a chunk of XML to a SAX ContentHandler.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TAGNAME

public static final String TAGNAME

See Also:

Constant Field Values

Constructor Detail

ICEEventLog

public ICEEventLog(String version,
                   Collection log)

Create a new ICE event log.

Parameters:

version - The version of the event log

log - A collection of events (ICEEventMsg or ICEEventInfo)

ICEEventLog

public ICEEventLog(Attributes attributes)

Create a new ICE event log. This constructor is used by ICEInput to decode an ICE event log from an ICE payload.

Parameters:

attribute - The attributes of the ice-event-log tag

Method Detail

getLog

public Collection getLog()

Get the event log.

Returns:

A collection of events (ICEEventInfo or ICEEventMsg)

startElement

public IICECharacterHandler startElement(String name,
                                         Attributes attributes,
                                         PreparsedXML input)
                                  throws SAXException

Receive notification of the beginning of an element. ICEInput invokes this method upon a start element event from the underlying SAX parser.

Specified by:

startElement in interface IICEElementHandler

Parameters:

name - The local name of the XML element (we don't need namespaces at this point)

attribute - The attributes of the XML element

input - The preparsed XML stream to get the element content

Returns:

An IICECharacterHandler to receive the character events from the SAX parser or null if the character events could be ignored

Throws:

SAXException - on error (might wrap another exception)

endElement

public boolean endElement(String name)
                   throws SAXException

Receive notification of the end of an element. ICEInput invokes this method upon an end element event from the underlying SAX parser.

Specified by:

endElement in interface IICEElementHandler

Parameters:

name - The local name of the XML element (we don't need namespaces at this point)

Returns:

true if this handler should still receive SAX element events, false if this handler isn't interested in the following SAX element events

Throws:

SAXException - on error (might wrap another exception)

write

public void write(ContentHandler handler)
           throws SAXException

Write the XML representation of the ICE element to a SAX ContentHandler. This method is used by ICEOutput to create an ICE payload.

Specified by:

write in interface IICEElement

Parameters:

handler - The SAX ContentHandler (usually an XMLSerializer)

Throws:

SAXException - on error (might wrap another exception)

writeChunk

public boolean writeChunk(ContentHandler handler)
                   throws SAXException

Write a chunk of XML to a SAX ContentHandler. This method is used by ICEOutput to write an ICE payload in chunked mode.

Specified by:

writeChunk in interface IICEElement

Parameters:

handler - The SAX ContentHandler (usually a XMLSerializer)

Returns:

true if there are more chunks in the queue

Throws:

SAXException - on error (might wrap another exception)

store

public Node store(Document document)

Store the informations into a DOM.

Specified by:

store in interface IDOMStorable

Parameters:

document - The DOM document that should be used as factory for the DOM elements

Returns:

A Node containing the informations of the configuration object (this might be the document element of the XML that is eventually written to the repository)

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM