Changeset 4704


Ignore:
Timestamp:
03/14/14 16:38:45 (10 years ago)
Author:
Oliver Schonefeld
Message:
  • add elements and attributes needed to indicating the Data Views supported by a Resource and the Data View delivery policy stuff.
Location:
FederatedSearch
Files:
3 edited

Legend:

Unmodified
Added
Removed

  • FederatedSearch/examples/Endpoint-Description-Complex.xml

    r4677 r4704  
    88    </Capabilities>
    99    <SupportedDataViews>
    10         <SupportedDataView id="dv1">application/x-clarin-fcs-hits+xml</SupportedDataView>
    11         <SupportedDataView id="dv2">application/x-cmdi+xml</SupportedDataView>
     10        <SupportedDataView id="dv1" delivery-policy="send-default">application/x-clarin-fcs-hits+xml</SupportedDataView>
     11        <SupportedDataView id="dv2" delivery-policy="need-to-request">application/x-cmdi+xml</SupportedDataView>
    1212    </SupportedDataViews>
    1313    <Resources>
    … …  
    2121                <Language>deu</Language>
    2222            </Languages>
     23            <AvailableDataViews ref="dv1"/>
    2324        </Resource>
    2425        <Resource pid="hdl:10932/mannheimer_morgen">
    … …  
    2930                <Language>deu</Language>
    3031            </Languages>
     32            <AvailableDataViews ref="dv1 dv2"/>
    3133            <Resources>
    3234                <Resource pid="hdl:10932/mannheimer_morgen_before_1990">
    … …  
    3739                        <Language>deu</Language>
    3840                    </Languages>
     41                    <AvailableDataViews ref="dv1 dv2"/>
    3942                </Resource>
    4043                <Resource pid="hdl:10932/mannheimer_morgen_after_1990">
    … …  
    4548                        <Language>deu</Language>
    4649                    </Languages>
     50                    <AvailableDataViews ref="dv1 dv2"/>
    4751                </Resource>
    4852            </Resources>

  • FederatedSearch/examples/Endpoint-Description-Simple.xml

    r4677 r4704  
    99    </Capabilities>
    1010    <SupportedDataViews>
    11         <SupportedDataView id="dv1">application/x-clarin-fcs-hits+xml</SupportedDataView>
     11        <SupportedDataView id="dv1" delivery-policy="send-default">application/x-clarin-fcs-hits+xml</SupportedDataView>
    1212    </SupportedDataViews>
    1313    <Resources>
    … …  
    2121                <Language>deu</Language>
    2222            </Languages>
     23            <AvailableDataViews ref="dv1" />
    2324        </Resource>
    2425    </Resources>

  • FederatedSearch/schema/Endpoint-Description.xsd

    r4677 r4704  
    9292                                    <xs:simpleContent>
    9393                                        <xs:extension base="ed:mimetypeString">
    94                                             <xs:attribute name="id" type="xs:ID" use="required" />
     94                                            <xs:attribute name="id" type="xs:ID" use="required">
     95                                                <xs:annotation>
     96                                                    <xs:documentation>
     97                                                        <h:p>
     98                                                            An unique ID for this support Data View. This value will be used,
     99                                                            when referencing in the &lt;AvailableDataViews&gt; element in
     100                                                            the &lt;Resource&gt; description.
     101                                                        </h:p>
     102                                                    </xs:documentation>
     103                                                </xs:annotation>
     104                                            </xs:attribute>
     105                                            <xs:attribute name="delivery-policy" use="required">
     106                                                <xs:annotation>
     107                                                    <xs:documentation>
     108                                                        <h:p>
     109                                                            This attribute indicated the <h:em>delivery policy</h:em> of this supported Data View.
     110                                                        </h:p>
     111                                                    </xs:documentation>
     112                                                </xs:annotation>
     113                                                <xs:simpleType>
     114                                                    <xs:restriction base="xs:string">
     115                                                        <xs:enumeration value="send-default">
     116                                                            <xs:annotation>
     117                                                                <xs:documentation>
     118                                                                    <h:p>
     119                                                                        This Data View is automatically sent by the Endpoint for supported Resources.
     120                                                                    </h:p>
     121                                                                </xs:documentation>
     122                                                            </xs:annotation>
     123                                                        </xs:enumeration>
     124                                                        <xs:enumeration value="need-to-request">
     125                                                            <xs:annotation>
     126                                                                <xs:documentation>
     127                                                                    <h:p>
     128                                                                        This Data View needs to be explicatively requested by the Client.
     129                                                                    </h:p>
     130                                                                </xs:documentation>
     131                                                            </xs:annotation>
     132                                                        </xs:enumeration>
     133                                                    </xs:restriction>
     134                                                </xs:simpleType>
     135                                            </xs:attribute>
    95136                                        </xs:extension>
    96137                                    </xs:simpleContent>
    … …  
    229270                    </xs:complexType>
    230271                </xs:element>
     272               
     273                <xs:element name="AvailableDataViews">
     274                    <xs:annotation>
     275                        <xs:documentation>
     276                            <h:p>
     277                                This element contains a reference to all Data Views that are
     278                                supported by this resource in the <h:code>@ref</h:code> attribute.
     279                            </h:p>
     280                        </xs:documentation>
     281                    </xs:annotation>
     282                    <xs:complexType>
     283                        <xs:attribute name="ref" type="xs:IDREFS" use="required" />
     284                    </xs:complexType>
     285                </xs:element>
    231286
    232287                <xs:element ref="ed:Resources" minOccurs="0">
Note: See TracChangeset for help on using the changeset viewer.