srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/schema/searchMethods.exsd
changeset 0 a02c979e8dfd
equal deleted inserted replaced
-1:000000000000 0:a02c979e8dfd
       
     1 <?xml version='1.0' encoding='UTF-8'?>
       
     2 <!-- Schema file written by PDE -->
       
     3 <schema targetNamespace="com.nokia.s60tools.apiquery">
       
     4 <annotation>
       
     5       <appInfo>
       
     6          <meta.schema plugin="com.nokia.s60tools.apiquery" id="searchMethods" name="com.nokia.s60tools.apiquery.searchMethods"/>
       
     7       </appInfo>
       
     8       <documentation>
       
     9          It can be used to add another serachmethod to query api information.
       
    10       </documentation>
       
    11    </annotation>
       
    12 
       
    13    <element name="extension">
       
    14       <complexType>
       
    15          <sequence>
       
    16             <element ref="searchMethod" minOccurs="1" maxOccurs="unbounded"/>
       
    17          </sequence>
       
    18          <attribute name="point" type="string" use="required">
       
    19             <annotation>
       
    20                <documentation>
       
    21                   a fully qualified identifier of the target extension point
       
    22                </documentation>
       
    23             </annotation>
       
    24          </attribute>
       
    25          <attribute name="id" type="string">
       
    26             <annotation>
       
    27                <documentation>
       
    28                   an optional identifier of the extension instance
       
    29                </documentation>
       
    30             </annotation>
       
    31          </attribute>
       
    32          <attribute name="name" type="string">
       
    33             <annotation>
       
    34                <documentation>
       
    35                   an optional name of the extension instance
       
    36                </documentation>
       
    37                <appInfo>
       
    38                   <meta.attribute translatable="true"/>
       
    39                </appInfo>
       
    40             </annotation>
       
    41          </attribute>
       
    42       </complexType>
       
    43    </element>
       
    44 
       
    45    <element name="searchMethod">
       
    46       <complexType>
       
    47          <attribute name="class" type="string" use="required">
       
    48             <annotation>
       
    49                <documentation>
       
    50                   a fully qualified name of the class that implements com.nokia.s60tools.apiquery.shared.searchmethod.ISearchMethodExtension
       
    51  or subclass com.nokia.s60tools.apiquery.shared.searchmethod.AbstractSearchMethodExtension
       
    52                </documentation>
       
    53                <appInfo>
       
    54                   <meta.attribute kind="java" basedOn="com.nokia.s60tools.apiquery.searchmethodregistry.ISearchMethodExtension"/>
       
    55                </appInfo>
       
    56             </annotation>
       
    57          </attribute>
       
    58          <attribute name="description" type="string" use="required">
       
    59             <annotation>
       
    60                <documentation>
       
    61                   Unique source name
       
    62                </documentation>
       
    63             </annotation>
       
    64          </attribute>
       
    65          <attribute name="id" type="string" use="required">
       
    66             <annotation>
       
    67                <documentation>
       
    68                   unique Id
       
    69                </documentation>
       
    70             </annotation>
       
    71          </attribute>
       
    72          <attribute name="isDefault" type="boolean" use="default" value="false">
       
    73             <annotation>
       
    74                <documentation>
       
    75                   To use the current source as default source
       
    76                </documentation>
       
    77             </annotation>
       
    78          </attribute>
       
    79       </complexType>
       
    80    </element>
       
    81 
       
    82    <annotation>
       
    83       <appInfo>
       
    84          <meta.section type="examples"/>
       
    85       </appInfo>
       
    86       <documentation>
       
    87          The following is an example of Web extension point:
       
    88 
       
    89   &amp;lt;extension
       
    90          point=&amp;quot;com.nokia.s60tools.apiquery.searchMethods&amp;quot;&amp;gt;
       
    91       &amp;lt;searchMethod
       
    92             class=&amp;quot;com.nokia.s60tools.apiquery.web.searchmethod.WebServerSearchMethodExtension&amp;quot;
       
    93             description=&amp;quot;Web Server&amp;quot;
       
    94             id=&amp;quot;web&amp;quot;
       
    95             isDefault=&amp;quot;true&amp;quot;/&amp;gt;
       
    96    &amp;lt;/extension&amp;gt;
       
    97       </documentation>
       
    98    </annotation>
       
    99 
       
   100    <annotation>
       
   101       <appInfo>
       
   102          <meta.section type="apiInfo"/>
       
   103       </appInfo>
       
   104       <documentation>
       
   105          The value of the class attribute must be a fully qualified name of the class that implements com.nokia.s60tools.apiquery.shared.searchmethod.ISearchMethodExtension or subclass  com.nokia.s60tools.apiquery.shared.searchmethod.AbstractSearchMethodExtension when developing a new serach method.
       
   106       </documentation>
       
   107    </annotation>
       
   108 
       
   109    <annotation>
       
   110       <appInfo>
       
   111          <meta.section type="implementation"/>
       
   112       </appInfo>
       
   113       <documentation>
       
   114          APIQuery is provided with 3 serach methods :cache,web and excel sheets which are the extension of this plugin.
       
   115       </documentation>
       
   116    </annotation>
       
   117 
       
   118    <annotation>
       
   119       <appInfo>
       
   120          <meta.section type="copyright"/>
       
   121       </appInfo>
       
   122       <documentation>
       
   123          
       
   124  Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
       
   125  All rights reserved.
       
   126 
       
   127  This component and the accompanying materials are made available
       
   128  under the terms of &quot;Eclipse Public License v1.0&quot;
       
   129  which accompanies this distribution, and is available
       
   130  at the URL &quot;http://www.eclipse.org/legal/epl-v10.html&quot;.
       
   131       </documentation>
       
   132    </annotation>
       
   133 
       
   134 </schema>