summaryrefslogtreecommitdiffstats
path: root/sca-java-1.x/tags/kernel/2.0-alpha-incubating/spi/src/main/java/org/apache/tuscany/spi/model/DataType.java
blob: f36f3765ce51ac852b88c99efeefad275a3eb1e3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.    
 */
package org.apache.tuscany.spi.model;

import java.lang.reflect.Type;
import java.util.HashMap;
import java.util.Map;

/**
 * Representation of the type of data associated with an operation. Data is represented in two forms: the physical form
 * used by the runtime and a logical form used by the assembly. The physical form is a Java Type because the runtime is
 * written in Java. This may be the same form used by the application but it may not; for example, an application that
 * is performing stream processing may want a physical form such as an {@link java.io.InputStream InputStream} to
 * semantially operate on application data such as a purchase order. The logical description is that used by the
 * assembly model and is an identifier into some well-known type space; examples may be a Java type represented by its
 * Class or an XML type represented by its QName. Every data type may also contain metadata describing the expected
 * data; for example, it could specify a preferred data binding technology or the size of a typical instance.
 *
 * @version $Rev$ $Date$
 */
public class DataType<L> extends ModelObject implements Cloneable {
    private String dataBinding = Object.class.getName();

    private final Type physical;

    private final L logical;

    private Map<String, Object> metadata = new HashMap<String, Object>();

    private Operation operation;

    /**
     * Construct a data type specifying the physical and logical types.
     *
     * @param physical the physical class used by the runtime
     * @param logical  the logical type
     * @see #getLogical()
     */
    public DataType(Type physical, L logical) {
        this.physical = physical;
        this.logical = logical;
        if (physical instanceof Class) {
            this.dataBinding = ((Class) physical).getName();
        }
    }

    public DataType(String dataBinding, Type physical, L logical) {
        this.dataBinding = dataBinding;
        this.physical = physical;
        this.logical = logical;
    }

    /**
     * Returns the physical type used by the runtime.
     *
     * @return the physical type used by the runtime
     */
    public Type getPhysical() {
        return physical;
    }

    /**
     * Returns the logical identifier used by the assembly. The type of this value identifies the logical type system in
     * use. Known values are: <ul> <li>a java.lang.reflect.Type identifies a Java type by name and ClassLoader; this
     * includes Java Classes as they are specializations of Type</li> <li>a javax.xml.namespace.QName identifies an XML
     * type by local name and namespace</li> </ul>
     *
     * @return the logical type name
     */
    public L getLogical() {
        return logical;
    }

    /**
     * Returns all metadata about this type.
     *
     * @return all metadata about this type
     */
    public Map<String, ?> getMetadata() {
        return metadata;
    }

    /**
     * Returns the specified metadata item or null if not present.
     *
     * @param name the name of the metadata item
     * @return the value, or null if not present
     */
    public Object getMetadata(String name) {
        return metadata.get(name);
    }

    /**
     * Sets the specified metadata value. A null value undefines it.
     *
     * @param name  the name of the metadata item
     * @param value the value, or null to undefine
     * @return the old value for the item, or null if not present
     */
    public Object setMetadata(String name, Object value) {
        if (value == null) {
            return metadata.remove(name);
        } else {
            return metadata.put(name, value);
        }
    }

    public String getDataBinding() {
        if (dataBinding == null) {
            // databinding is not set at the DataType level, check the operation
            Operation<?> operation = (Operation<?>) getOperation();
            if (operation != null) {
                return operation.getDataBinding();
            }
        }
        return dataBinding;
    }

    /**
     * @param dataBinding the dataBinding to set
     */
    public void setDataBinding(String dataBinding) {
        this.dataBinding = dataBinding;
    }

    public int hashCode() {
        int result;
        result = dataBinding != null ? dataBinding.hashCode() : 0;
        result = 29 * result + (physical != null ? physical.hashCode() : 0);
        result = 29 * result + (logical != null ? logical.hashCode() : 0);
        // Commented the following line out since it causes infinite loop from Operation.hashCode() 
        // if the metadata map contains the Operation
        // result = 29 * result + (metadata != null ? metadata.hashCode() : 0);
        return result;
    }

    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }

        final DataType dataType = (DataType) o;

        if (dataBinding != null ? !dataBinding.equals(dataType.dataBinding) : dataType.dataBinding != null) {
            return false;
        }
        if (logical != null ? !logical.equals(dataType.logical) : dataType.logical != null) {
            return false;
        }
        return !(physical != null ? !physical.equals(dataType.physical) : dataType.physical != null);

    }

//    @SuppressWarnings("unchecked")
//    public boolean equals(Object o) {
//        if (this == o) {
//            return true;
//        }
//        if (o == null || getClass() != o.getClass()) {
//            return false;
//        }
//
//        final DataType dataType = (DataType) o;
//
//        if (logical instanceof Class && dataType.logical instanceof Class) {
//            Class<?> logicalClass = (Class<?>) logical;
//            Class<?> targetLogicalClass = (Class<?>) dataType.logical;
//            if (!logicalClass.isAssignableFrom(targetLogicalClass)) {
//                return false;
//            }
//        } else {
//            if (logical != null ? !logical.equals(dataType.logical) : dataType.logical != null) {
//                return false;
//            }
//        }
//        if (physical instanceof Class && dataType.physical instanceof Class) {
//            Class<?> physicalClass = (Class<?>) physical;
//            Class<?> physicalTargetClass = (Class<?>) dataType.physical;
//            if (dataBinding != null
//                && dataType.dataBinding != null
//                && dataBinding.equals(physicalClass.getName())
//                && dataType.dataBinding.equals(physicalTargetClass.getName())) {
//                return physicalClass.isAssignableFrom(physicalTargetClass);
//            }
//            if (!physicalClass.isAssignableFrom(physicalTargetClass)) {
//                return false;
//            }
//            return !(dataBinding != null ? !dataBinding.equals(dataType.dataBinding) : dataType.dataBinding != null);
//
//
//        }
//
//        if (dataBinding != null ? !dataBinding.equals(dataType.dataBinding) : dataType.dataBinding != null) {
//            return false;
//        }
//
//        return !(physical != null ? !physical.equals(dataType.physical) : dataType.physical != null);
//    }

    public String toString() {
        StringBuffer sb = new StringBuffer();
        sb.append(physical).append(" ").append(dataBinding).append(" ").append(logical);
        return sb.toString();
    }

    @SuppressWarnings("unchecked")
    @Override
    public Object clone() throws CloneNotSupportedException {
        DataType<L> copy = (DataType<L>) super.clone();
        assert this.metadata instanceof HashMap;
        copy.metadata = (HashMap<String, Object>) ((HashMap) this.metadata).clone();
        return copy;
    }

    public Operation getOperation() {
        return operation;
    }

    public void setOperation(Operation operation) {
        this.operation = operation;
    }

}