XML Schema "searchconfig.xsd"
Target Namespace:
<global>
Components:
1 global element, 11 local elements, 9 complexTypes
Schema Location:
lumis\search\searchconfig.xsd, see XML source
All Element Summary
attribute (type criteriaAttribute) Attribute name and value that belongs to a criteria and will be used to match an information being indexed or searched.
Type:
criteriaAttribute
Content:
simple, 1 attribute
Defined:
locally at 1 location
config (within indexer) Indexer configuration.
Type:
anySimpleType
Content:
simple
Defined:
locally at 1 location
config (within searcher) Searcher configuration.
Type:
anySimpleType
Content:
simple
Defined:
locally at 1 location
criteria (type criteria) Specifies a collection of attributes and respective values.
Type:
criteria
Content:
complex, 1 attribute, 1 element
Defined:
locally at 1 location
criterias (type criterias) Collection of criterias of specific configurations.
Type:
criterias
Content:
complex, 1 element
Defined:
locally at 1 location
indexer (type indexer) Indexer definition.
Type:
indexer
Content:
complex, 2 attributes, 1 element
Defined:
locally at 1 location
indexers (type indexers) Collection of indexers of a search engine.
Type:
indexers
Content:
complex, 1 element
Defined:
locally at 1 location
searchConfig Root of the search configuration.
Type:
embedded complexType
Content:
complex, 2 elements
Includes:
definitions of 2 elements
Used:
never
searchEngine (type searchEngine) Search engine configuration.
Type:
searchEngine
Content:
complex, 1 attribute, 2 elements
Defined:
locally at 1 location
searchEngines (type searchEngines) Collection of configured search engines.
Type:
searchEngines
Content:
complex, 1 element
Defined:
locally at 1 location
searcher (type searcher) Searcher definition.
Type:
searcher
Content:
complex, 2 attributes, 1 element
Defined:
locally at 1 location
searchers (type searchers) Collection of searchers of a search engine.
Type:
searchers
Content:
complex, 1 element
Defined:
locally at 1 location
Complex Type Summary
criteria Specifies a collection of attributes and respective values.
Content:
complex, 1 attribute, 1 element
Includes:
definitions of 1 attribute and 1 element
Used:
at 1 location
criteriaAttribute Attribute name and value that belongs to a criteria and will be used to match an information being indexed or searched.
Content:
simple, 1 attribute
Includes:
definition of 1 attribute
Used:
at 1 location
criterias Collection of criterias of specific configurations.
Content:
complex, 1 element
Includes:
definition of 1 element
Used:
at 1 location
indexer Indexer definition.
Content:
complex, 2 attributes, 1 element
Includes:
definitions of 2 attributes and 1 element
Used:
at 1 location
indexers Collection of indexers of a search engine.
Content:
complex, 1 element
Includes:
definition of 1 element
Used:
at 1 location
searchEngine Search engine configuration.
Content:
complex, 1 attribute, 2 elements
Includes:
definitions of 1 attribute and 2 elements
Used:
at 1 location
searchEngines Collection of configured search engines.
Content:
complex, 1 element
Includes:
definition of 1 element
Used:
at 1 location
searcher Searcher definition.
Content:
complex, 2 attributes, 1 element
Includes:
definitions of 2 attributes and 1 element
Used:
at 1 location
searchers Collection of searchers of a search engine.
Content:
complex, 1 element
Includes:
definition of 1 element
Used:
at 1 location
XML Source
<?xml version="1.0" encoding="UTF-8"?>
<!-- $Revision: 6641 $ $Date: 2007-04-27 19:02:30 -0300 (Fri, 27 Apr 2007) $ -->
<xsd:schema xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<xsd:complexType name="criteriaAttribute">
<xsd:annotation>
<xsd:documentation>
Attribute name and value that belongs to a criteria and will be used to match an information being indexed or searched.
<BR/>
For more information, see element
<CODE>searchConfig/criterias/criteria</CODE>
.
<BR/>
The content of this element represents the attribute value.
</xsd:documentation>
</xsd:annotation>
<xsd:simpleContent>
<xsd:extension base="xsd:string">
<xsd:attribute name="name" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Attribute name.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
<xsd:complexType name="criteria">
<xsd:annotation>
<xsd:documentation>
Specifies a collection of attributes and respective values. If an information that is being indexed
(encapsulated in SearchContentField objects) or searched (encapsulated in a SearchQuery
object's attributes) matches the values of a criteria, this criteria is used to identify which
<CODE>config</CODE>
node will be used to configure the respective Indexer or Searcher object that
will perform the indexing or searching.
<BR/>
<BR/>
Example: If we have the following Indexer configuration:
<CODE>
<BR/>
...
<BR/>
&lt;indexer id="default" className="lumis.search.lucene.LuceneIndexer"&gt;
<BR/>
&#160;&#160;&#160;&lt;config&gt;
<BR/>
&#160;&#160;&#160;&#160;&#160;&#160;&lt;indexBasePath&gt;C:\indexes\default&lt;/indexBasePath&gt;
<BR/>
&#160;&#160;&#160;&lt;/config&gt;
<BR/>
&#160;&#160;&#160;&lt;config criteriaId="SportNews"&gt;
<BR/>
&#160;&#160;&#160;&#160;&#160;&#160;&lt;indexBasePath&gt;C:\indexes\SportNews&lt;/indexBasePath&gt;
<BR/>
&#160;&#160;&#160;&lt;/config&gt;
<BR/>
&lt;/indexer&gt;
<BR/>
...
<BR/>
&lt;criteria id="SportNews"&gt;
<BR/>
&#160;&#160;&#160;&lt;attribute name="lum_serviceInstanceId"&gt;BAD7D575B9BF11DAAFA7198B7D208AAD&lt;/attribute&gt;
<BR/>
&lt;/criteria&gt;
</CODE>
All contents of the service instance
<CODE>BAD7D575B9BF11DAAFA7198B7D208AAD</CODE>
will be
indexed to the directory
<CODE>C:\indexes\SportNews</CODE>
, while all other contents will be indexed
to the directory
<CODE>C:\indexes\default</CODE>
.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element maxOccurs="unbounded" minOccurs="1" name="attribute" type="criteriaAttribute">
<xsd:annotation>
<xsd:documentation>
<!-- copied from type criteriaAttribute -->
Attribute name and value that belongs to a criteria and will be used to match an information being indexed or searched.
<BR/>
For more information, see element
<CODE>searchConfig/criterias/criteria</CODE>
.
<BR/>
The content of this element represents the attribute value.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
<xsd:attribute name="id" type="xsd:string" use="required"/>
</xsd:complexType>
<xsd:complexType name="criterias">
<xsd:annotation>
<xsd:documentation>
Collection of criterias of specific configurations.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element maxOccurs="unbounded" minOccurs="0" name="criteria" type="criteria">
<xsd:annotation>
<xsd:documentation>
<!-- copied from type criteria -->
Specifies a collection of attributes and respective values. If an information that is being indexed
(encapsulated in SearchContentField objects) or searched (encapsulated in a SearchQuery
object's attributes) matches the values of a criteria, this criteria is used to identify which
<CODE>config</CODE>
node will be used to configure the respective Indexer or Searcher object that
will perform the indexing or searching.
<BR/>
<BR/>
Example: If we have the following Indexer configuration:
<CODE>
<BR/>
...
<BR/>
&lt;indexer id="default" className="lumis.search.lucene.LuceneIndexer"&gt;
<BR/>
&#160;&#160;&#160;&lt;config&gt;
<BR/>
&#160;&#160;&#160;&#160;&#160;&#160;&lt;indexBasePath&gt;C:\indexes\default&lt;/indexBasePath&gt;
<BR/>
&#160;&#160;&#160;&lt;/config&gt;
<BR/>
&#160;&#160;&#160;&lt;config criteriaId="SportNews"&gt;
<BR/>
&#160;&#160;&#160;&#160;&#160;&#160;&lt;indexBasePath&gt;C:\indexes\SportNews&lt;/indexBasePath&gt;
<BR/>
&#160;&#160;&#160;&lt;/config&gt;
<BR/>
&lt;/indexer&gt;
<BR/>
...
<BR/>
&lt;criteria id="SportNews"&gt;
<BR/>
&#160;&#160;&#160;&lt;attribute name="lum_serviceInstanceId"&gt;BAD7D575B9BF11DAAFA7198B7D208AAD&lt;/attribute&gt;
<BR/>
&lt;/criteria&gt;
</CODE>
All contents of the service instance
<CODE>BAD7D575B9BF11DAAFA7198B7D208AAD</CODE>
will be
indexed to the directory
<CODE>C:\indexes\SportNews</CODE>
, while all other contents will be indexed
to the directory
<CODE>C:\indexes\default</CODE>
.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="searcher">
<xsd:annotation>
<xsd:documentation>
Searcher definition.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="1" name="config">
<xsd:annotation>
<xsd:documentation>
Searcher configuration. This node is passed to the searcher object and its schema is specific
for each searcher implementation.
<BR/>
<BR/>
<B>
Schema for Default Implementation (className="lumis.search.lucene.LuceneSearcher")
</B>
<BR/>
<BR/>
<B>Example:</B>
<CODE>
<BR/>
&lt;indexBasePath&gt;${lum_portalDataPath}lucene/index/${lum_serviceInstanceId}&lt;/indexBasePath&gt;
<BR/>
&lt;indexBasePath indexerId="default" /&gt;
</CODE>
<BR/>
<BR/>
<B>
Element
<CODE>indexBasePath</CODE>
</B>
: Define the path to the directory used by Lucene to search for data.
<BR/>
The value can contain EL tags to be replaced in runtime by the respective field value.
(e.g.
<CODE>${lum_portalDataPath}</CODE>
will be replaced by the value of the field with name
<CODE>"lum_portalDataPath"</CODE>
).
<BR/>
The
<CODE>config</CODE>
element must contain at least one
<CODE>indexBasePath</CODE>
and can contain more than
one of this element, to define one or more indexes to use when searching for data.
<BR/>
The
<CODE>indexerId</CODE>
attribute can be used to specify that the
<CODE>indexBasePath</CODE>
element
must use all
<CODE>indexBasePath</CODE>
definition of the specified indexer. This allows the reuse of a
<CODE>indexBasePath</CODE>
definition set.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
<xsd:attribute name="id" type="xsd:string" use="required">
<xsd:annotation>
<xsd:documentation>
Searcher identifier.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="className" type="xsd:string" use="required">
<xsd:annotation>
<xsd:documentation>
Searcher class name.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
<xsd:complexType name="indexer">
<xsd:annotation>
<xsd:documentation>
Indexer definition.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="1" name="config">
<xsd:annotation>
<xsd:documentation>
<![CDATA[
Indexer configuration. This node is passed to the indexer object and its schema is specific
for each indexer implementation.
<BR/><BR/>
<B>Schema for Default Implementation (className="lumis.search.lucene.LuceneIndexer")</B>
<BR/><BR/>
<B>Example:</B>
<CODE>
<BR/>&lt;indexBasePath&gt;${lum_portalDataPath}lucene/index/${lum_serviceInstanceId}&lt;/indexBasePath&gt;
<BR/>&lt;maxFieldLength&gt;10000&lt;/maxFieldLength&gt;
<BR/>&lt;analyzer className="lumis.search.lucene.LumisAnalyzer"&gt;
<BR/>&#160;&#160;&#160;&lt;tokenizerClassName&gt;org.apache.lucene.analysis.standard.StandardTokenizer&lt;/tokenizerClassName&gt;
<BR/>&#160;&#160;&#160;&lt;tokenFilterClassName&gt;org.apache.lucene.analysis.standard.StandardFilter&lt;/tokenFilterClassName&gt;
<BR/>&#160;&#160;&#160;&lt;tokenFilterClassName&gt;org.apache.lucene.analysis.LowerCaseFilter&lt;/tokenFilterClassName&gt;
<BR/>&#160;&#160;&#160;&lt;tokenFilterClassName&gt;lumis.search.lucene.AccentFilter&lt;/tokenFilterClassName&gt;
<BR/>&lt;/analyzer&gt;
</CODE>
<BR/><BR/>
<B>Element <CODE>indexBasePath</CODE></B>: Define the path to the directory used by Lucene to index data.<BR/>
The value can contain EL tags to be replaced in runtime by the respective field value.
(e.g. <CODE>${lum_portalDataPath}</CODE> will be replaced by the value of the field with name
<CODE>"lum_portalDataPath"</CODE>).<BR/>
The config element must contain at least one <CODE>indexBasePath</CODE> and can contain more than one of this
element, to define one or more indexes to store information being indexed.
<BR/><BR/>
<B>Element <CODE>maxFieldLength</CODE></B>: Define the maximum length for field values to be indexed.<BR/>
Default value:<BR/>
&lt;maxFieldLength&gt;10000&lt;/maxFieldLength&gt;
<BR/><BR/>
<B>Element <CODE>analyzer</CODE></B>: Define classes for the analyzer, tokenizer and token filters, to be used
in indexing processes.<BR/>
Default value:
<BR/>&lt;analyzer className="lumis.search.lucene.LumisAnalyzer"&gt;
<BR/>&#160;&#160;&#160;&lt;tokenizerClassName&gt;org.apache.lucene.analysis.standard.StandardTokenizer&lt;/tokenizerClassName&gt;
<BR/>&#160;&#160;&#160;&lt;tokenFilterClassName&gt;org.apache.lucene.analysis.standard.StandardFilter&lt;/tokenFilterClassName&gt;
<BR/>&#160;&#160;&#160;&lt;tokenFilterClassName&gt;org.apache.lucene.analysis.LowerCaseFilter&lt;/tokenFilterClassName&gt;
<BR/>&#160;&#160;&#160;&lt;tokenFilterClassName&gt;lumis.search.lucene.AccentFilter&lt;/tokenFilterClassName&gt;
<BR/>&lt;/analyzer&gt;
]]>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
<xsd:attribute name="id" type="xsd:string" use="required">
<xsd:annotation>
<xsd:documentation>
Indexer identifier.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="className" type="xsd:string" use="required">
<xsd:annotation>
<xsd:documentation>
Indexer class name.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
<xsd:complexType name="indexers">
<xsd:annotation>
<xsd:documentation>
Collection of indexers of a search engine.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element maxOccurs="unbounded" minOccurs="1" name="indexer" type="indexer">
<xsd:annotation>
<xsd:documentation>
<!-- copied from type indexer -->
Indexer definition.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="searchers">
<xsd:annotation>
<xsd:documentation>
Collection of searchers of a search engine.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element maxOccurs="unbounded" minOccurs="1" name="searcher" type="searcher">
<xsd:annotation>
<xsd:documentation>
<!-- copied from type searcher -->
Searcher definition.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="searchEngine">
<xsd:annotation>
<xsd:documentation>
Search engine configuration. Define indexers and searchers of the search engine.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="1" name="indexers" type="indexers">
<xsd:annotation>
<xsd:documentation>
<!-- copied from type indexers -->
Collection of indexers of a search engine.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element maxOccurs="1" minOccurs="1" name="searchers" type="searchers">
<xsd:annotation>
<xsd:documentation>
<!-- copied from type searcher -->
Collection of searchers of a search engine.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
<xsd:attribute name="id" type="xsd:string"/>
</xsd:complexType>
<xsd:complexType name="searchEngines">
<xsd:annotation>
<xsd:documentation>
Collection of configured search engines.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="1" name="searchEngine" type="searchEngine">
<xsd:annotation>
<xsd:documentation>
<!-- copied from type searchEngine -->
Search engine configuration. Define indexers and searchers of the search engine.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:element name="searchConfig">
<xsd:annotation>
<xsd:documentation>
Root of the search configuration.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element minOccurs="1" name="searchEngines" type="searchEngines">
<xsd:annotation>
<xsd:documentation>
<!-- copied from type searchEngines -->
Collection of configured search engines.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="criterias" type="criterias">
<xsd:annotation>
<xsd:documentation>
<!-- copied from type criterias -->
Collection of criterias of specific configurations.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:schema>
XML Schema documentation generated with DocFlex/XML (Kit) v1.6.2
DocFlex/XML is a powerful template-driven documentation and report generator from any data stored in XML files. Based on an innovative technology developed by FILIGRIS WORKS, this new tool offers virtuoso data querying and formatting capabilities not found in anything else!
Need to convert your XML data into a clear nice-looking documentation or reports? Web-ready hypertext HTML or printable MS Word / OpenOffice.org friendly RTF? DocFlex/XML may be a cheap, quick and effective solution exactly for this task!
Have questions? Not sure how to use it? Just send us e-mail to contact@filigris.com and we are always happy to help you! See also our services at www.filigris.com

Lumisportal  7.1.0.131121 - Copyright © 2006–2013 Lumis EIP Tecnologia da Informação LTDA. All Rights Reserved.