com.sapportals.wcm.protocol.ice.protocol

Class ICEItemGroup

java.lang.Object
  com.sapportals.wcm.protocol.ice.protocol.ICEItemBase
      com.sapportals.wcm.protocol.ice.protocol.ICEItemCollection
          com.sapportals.wcm.protocol.ice.protocol.ICEItemGroup

All Implemented Interfaces:

IICEElement

public class ICEItemGroup
extends ICEItemCollection

ICEItemGroup is a representation of an ice-item-group element inside an ice-package.

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

 <!ENTITY % attlist.item "
           activation            CDATA           #IMPLIED
           expiration            CDATA           #IMPLIED
           content-filename      CDATA           #IMPLIED
           content-transfer-encoding   (base64 | x-native-xml)
                                                'x-native-xml'
           content-type          CDATA          'application/octet-stream'
           ip-status             CDATA           #IMPLIED
           xml:lang              CDATA           #IMPLIED
           license               CDATA           #IMPLIED
           rights-holder         CDATA           #IMPLIED
           show-credit           CDATA           #IMPLIED
           subscription-element  CDATA           #IMPLIED
 ">
 <!ENTITY % cm.content           "ice-item-group |
                                  ice-item |
                                  ice-item-ref" >
 <!ENTITY % cm.package           "((ice-item-remove+, (%cm.content;)*) |
                                  (%cm.content;)+)" >

 <!ELEMENT ice-item-group        ((%cm.package;)+) >
 <!ATTLIST ice-item-group        %attlist.item;
           ice-element           CDATA   #FIXED 'ice-item-group'
           name                  CDATA           #IMPLIED
           item-group-id         CDATA           #REQUIRED
 >

Copyright 2004 SAP AG

Field Summary

Fields inherited from class com.sapportals.wcm.protocol.ice.protocol.ICEItemCollection

m_itemIterator

Constructor Summary

ICEItemGroup(Attributes attributes)
Create a new ICE item group.

ICEItemGroup(String itemGroupID, String subscriptionElement, String contentFilename, IICEItemIterator itemIterator)
Create a new ICE item group.

Method Summary

String	getContentFilename() Get the relative filename of the ICE item group.
String	getSubscriptionElement() Get the persistent identifier of the item in the subscription context that should be added or modified.
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

Constructor Detail

ICEItemGroup

public ICEItemGroup(String itemGroupID,
                    String subscriptionElement,
                    String contentFilename,
                    IICEItemIterator itemIterator)

Create a new ICE item group.

Parameters:

itemGroupID - The id of the group

subscriptionElement - The identifier of the item in a subscription (might be null)

contentFilename - The filename of the ICE item group or null

itemIterator - An item iterator defining the content of the group

ICEItemGroup

public ICEItemGroup(Attributes attributes)

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

Parameters:

attributes - The attributes of the ice-item-group tag

Method Detail

getSubscriptionElement

public String getSubscriptionElement()

Get the persistent identifier of the item in the subscription context that should be added or modified.

Returns:

The persistent identifier of the item in the subscription context.

getContentFilename

public String getContentFilename()

Get the relative filename of the ICE item group.

Returns:

The relative filename of the ICE item group or null

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.

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.

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)

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