01: /*
02: * <copyright>
03: *
04: * Copyright 2003-2004 BBNT Solutions, LLC
05: * under sponsorship of the Defense Advanced Research Projects
06: * Agency (DARPA).
07: *
08: * You can redistribute this software and/or modify it under the
09: * terms of the Cougaar Open Source License as published on the
10: * Cougaar Open Source Website (www.cougaar.org).
11: *
12: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
13: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
14: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
15: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
16: * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
17: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
18: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
19: * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
20: * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
22: * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23: *
24: * </copyright>
25: */
26: package org.cougaar.lib.aggagent.session;
27:
28: /**
29: * IncrementFormat is the interface implemented by Objects that convert local
30: * subscription data for transportation to other agents (aggregation agents,
31: * generally). Information obtained through the SubscriptionAccess interface
32: * can be translated in an arbitrary manner into an UpdateDelta, which is
33: * then shipped off as an XML document.
34: * <br><br>
35: * For many purposes, it suffices to use XmlIncrement (q.v.) with a suitable
36: * implementation of XMLEncoder, which is easier than creating a custom-built
37: * IncrementFormat from scratch.
38: */
39: public interface IncrementFormat {
40: /**
41: * Encode subscription data contained in the provided SubscriptionAccess as
42: * ResultSetDataAtoms and insert them as content. into the provided
43: * UpdateDelta. Please note that the implementation is responsible for
44: * calling setReplacement() with the appropriate value as part of this
45: * operation.
46: */
47: public void encode(UpdateDelta out, SubscriptionAccess sacc);
48: }
|