01: /*
02: * Copyright (c) 2004 JETA Software, Inc. All rights reserved.
03: *
04: * Redistribution and use in source and binary forms, with or without modification,
05: * are permitted provided that the following conditions are met:
06: *
07: * o Redistributions of source code must retain the above copyright notice,
08: * this list of conditions and the following disclaimer.
09: *
10: * o Redistributions in binary form must reproduce the above copyright notice,
11: * this list of conditions and the following disclaimer in the documentation
12: * and/or other materials provided with the distribution.
13: *
14: * o Neither the name of JETA Software nor the names of its contributors may
15: * be used to endorse or promote products derived from this software without
16: * specific prior written permission.
17: *
18: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19: * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21: * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
22: * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23: * INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24: * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
25: * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26: * INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27: * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28: */
29:
30: package com.jeta.forms.store.bean;
31:
32: import java.io.InputStream;
33:
34: import com.jeta.forms.gui.common.FormException;
35: import com.jeta.forms.store.memento.PropertiesMemento;
36:
37: /**
38: * A factory for creating BeanSerializer and BeanDeserializer instances. These
39: * classes are resonsible for serializing/deserializing the properties of a
40: * JETABean. Currently, bean properties are stored in a PropertiesMemento. See:
41: * {@link com.jeta.forms.gui.beans.JETABean} See
42: * {@link com.jeta.forms.store.memento.PropertiesMemento}
43: *
44: * @author Jeff Tassin
45: */
46: public interface BeanSerializerFactory {
47: /**
48: * A string that indentifies this component. Used primarily to register this
49: * factory in the JETARegistry.
50: */
51: public static String COMPONENT_ID = "bean.serializer.factory";
52:
53: /**
54: * Creates an instance of a BeanSerializer which can be used to serialize
55: * the properties of a JETABean.
56: *
57: * @return a bean serializer instance.
58: */
59: public BeanSerializer createSerializer();
60:
61: /**
62: * Creates an instance of a BeanSerializer which can be used to deserialize
63: * the properties of a JETABean.
64: *
65: * @param istream
66: * an input stream that contains a PropertiesMemento object. The
67: * deserializer uses the PropertiesMemento as a basis for
68: * creating and initializing JETABeans.
69: * @return a bean deserializer instance.
70: */
71: public BeanDeserializer createDeserializer(InputStream istream)
72: throws FormException;
73:
74: /**
75: * Creates an instance of a BeanDeserializer which can be used to
76: * deserialize the properties of a JETABean.
77: *
78: * @param pm
79: * an object that contains the serialized properties of a
80: * JETABean. The deserializer uses this as a basis for creating
81: * and initializing JETABeans.
82: * @return a bean deserializer instance.
83: */
84: public BeanDeserializer createDeserializer(PropertiesMemento pm)
85: throws FormException;
86:
87: }
|