com.sapportals.wcm.protocol.ice.protocol

Class ICEAccessWindow

java.lang.Object
  com.sapportals.wcm.protocol.ice.protocol.ICEAccessWindow

All Implemented Interfaces:

IICEElementHandler, IICEElement, IDOMStorable

public class ICEAccessWindow
extends Object
implements IICEElement, IICEElementHandler, IDOMStorable

ICEAccessWindow represents an ice-access-window element inside an ice-access. An ICEAccessWindow defines a timeslice when the content of an item referenced by the surrounding ice-item-ref could be accessed by the subscriber.

Detailed information about the ICE package structur could be found in the ICE 1.1 specification section 5.2 , the ice-item-ref element is described in section 5.2.2.3 . ice-access-window format

 <!ENTITY % cm.access-window "(ice-delivery-policy)" >

 <!ELEMENT ice-access-window %cm.access-window; >
 <!ATTLIST ice-access-window
id                    ID              #IMPLIED
name                  CDATA           #IMPLIED
description           CDATA           #IMPLIED
starttime             CDATA           #IMPLIED
stoptime              CDATA           #IMPLIED
 >

Copyright 2004 SAP AG

See Also:

ICEAccess, ICEItemRef

Field Summary

static String

TAGNAME

Constructor Summary

ICEAccessWindow(Attributes attributes)
Create a new ICEAccessWindow.

ICEAccessWindow(Element element)
Create an ICEAccessWindow object from a DOM-element.

ICEAccessWindow(Properties properties)

Method Summary

boolean	endElement(String name) Receive notification of the end of an element.
boolean	match(Date date) Check if a certain date matches the access window.
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

ICEAccessWindow

public ICEAccessWindow(Attributes attributes)

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

Parameters:

attributes - The attributes of the ice-access-window tag

ICEAccessWindow

public ICEAccessWindow(Element element)

Create an ICEAccessWindow object from a DOM-element.

Parameters:

element - The DOM-element containing the data of the access window

ICEAccessWindow

public ICEAccessWindow(Properties properties)
                throws com.sapportals.config.fwk.InitialConfigException,
                       com.sapportals.config.fwk.CannotAccessConfigException

Throws:

com.sapportals.config.fwk.InitialConfigException

com.sapportals.config.fwk.CannotAccessConfigException

Method Detail

match

public boolean match(Date date)

Check if a certain date matches the access window.

Parameters:

date - The date that should be checked.

Returns:

true if date matches the access window

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)

input - The preparsed XML stream to get the element content

attributes -

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 a 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-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM