Author: ssmiweve
Date: 2008-10-01 15:47:17 +0200 (Wed, 01 Oct 2008)
New Revision: 6860
Modified:
trunk/query-api/src/main/java/no/sesat/search/query/token/Categories.java
Log:
documentation on our different "metadata" Categories
Modified:
trunk/query-api/src/main/java/no/sesat/search/query/token/Categories.java
===================================================================
--- trunk/query-api/src/main/java/no/sesat/search/query/token/Categories.java
2008-10-01 10:48:26 UTC (rev 6859)
+++ trunk/query-api/src/main/java/no/sesat/search/query/token/Categories.java
2008-10-01 13:47:17 UTC (rev 6860)
@@ -25,112 +25,479 @@
* @version $Id$
*/
public enum Categories implements TokenPredicate {
+
+ /**
+ * [EMAIL PROTECTED] http://en.wikipedia.org/wiki/Category:Animals}
+ */
ANIMAL,
+ /**
+ * [EMAIL PROTECTED]
http://en.wikipedia.org/wiki/Category:Products_by_company} ???
+ * @deprecated use COMPANYBRANCH instead
+ */
CATEGORY,
+ /**
+ * [EMAIL PROTECTED] http://en.wikipedia.org/wiki/Category:Celebrities}
+ */
CELEBRITY,
+ /**
+ * [EMAIL PROTECTED]
http://en.wikipedia.org/wiki/Category:Products_by_company}
+ */
COMPANYBRANCH,
+ /**
+ * [EMAIL PROTECTED]
http://en.wikipedia.org/wiki/Category:Products_by_company}
+ * @deprecated a prioritised category of COMPANYBRANCH is business logic
+ */
COMPANYBRANCHKEYWORD,
+ /** Advertising categories, typically represented by "classifieds"
websites.
+ * [EMAIL PROTECTED] http://en.wikipedia.org/wiki/Category:Advertising}
+ */
CLASSIFIED_CATEGORY,
+ /**
+ * [EMAIL PROTECTED]
http://en.wikipedia.org/wiki/Category:Distribution,_retailing,_and_wholesaling}
+ * @todo rename to CHAIN_STORE
+ */
COMPANY_CHAIN,
+ /**
+ * @deprecated a prioritised category of COMPANYNAME is business logic
+ */
COMPANYENRICHMENT,
+ /**
+ * @deprecated a prioritised category of COMPANYBRANCH is business logic
+ */
COMPANY_KEYWORD,
+ /**
+ * @deprecated a prioritised category of COMPANYBRANCH is business logic
+ */
COMPANY_KEYWORD_RESERVED,
+ /**
+ * @deprecated a prioritised category of COMPANYNAME is business logic
+ */
BIGCOMPANY,
+ /**
+ * {@ link http://en.wikipedia.org/wiki/Category:Diseases}
+ */
DISEASE,
+ /**
+ * @[EMAIL PROTECTED]
http://en.wikipedia.org/wiki/Category:English_language}
+ */
ENGLISHWORDS,
+ /**
+ * [EMAIL PROTECTED] http://en.wikipedia.org/wiki/Category:Geography}
+ * National geographical places (according to current skin).
+ *
+ */
GEOLOCAL,
+ /**
+ * [EMAIL PROTECTED] http://en.wikipedia.org/wiki/Category:Geography}
+ * International geographical places.
+ */
GEOGLOBAL,
+ /**
+ * [EMAIL PROTECTED] http://en.wikipedia.org/wiki/Category:Boroughs}
+ */
GEO_BOROUGH,
+ /**
+ * [EMAIL PROTECTED] http://en.wikipedia.org/wiki/Category:Counties}
+ */
GEO_COUNTY,
+ /**
+ * [EMAIL PROTECTED]
http://en.wikipedia.org/wiki/Category:Streets_and_roads}
+ */
GEO_STREET,
+ /**
+ * [EMAIL PROTECTED] http://en.wikipedia.org/wiki/Category:Municipalities}
+ */
GEO_MUNICIPALITY,
+ /**
+ * @deprecated ambiguos (within a geographical context). Essentially it is
a mathematical term.
+ * Will be removed before Sesat-3.0
+ */
GEO_AREA,
+ /**
+ * [EMAIL PROTECTED]
http://en.wikipedia.org/wiki/Category:Postal_codes_by_country}
+ * @todo Will be renamed to GEO_POSTALCODE as ZIPCODE is an American name.
+ */
GEO_ZIPCODE,
+ /**
+ * @deprecated ambiguous. what is a postal place? somewhere that can
receive post?
+ */
GEO_POSTALPLACE,
+ /**
+ * [EMAIL PROTECTED] http://en.wikipedia.org/wiki/Category:Given_names}
+ * @todo rename to GIVEN_NAME as the position of the given name is
cultural.
+ */
FIRSTNAME,
+ /**
+ * @{link http://en.wikipedia.org/wiki/Category:Food_and_drink}
+ */
FOOD,
+ /**
+ * @{link http://en.wikipedia.org/wiki/Category:Names}
+ * @todo rename to NAME
+ */
FULLNAME,
+ /**
+ * [EMAIL PROTECTED] http://en.wikipedia.org/wiki/Category:Surnames}
+ * @todo rename to SURNAME as the position of the given name is cultural.
+ */
LASTNAME,
+ /**
+ * [EMAIL PROTECTED] http://en.wikipedia.org/wiki/Category:Materials}
+ */
MATERIAL,
+ /**
+ * [EMAIL PROTECTED] http://en.wikipedia.org/wiki/Category:Films}
+ */
MOVIE_TITLE,
+ /**
+ * [EMAIL PROTECTED] http://en.wikipedia.org/wiki/Category:Actors}
+ * @todo rename to ACTOR as they are not restricted to film.
+ */
MOVIE_ACTOR,
+ /**
+ * [EMAIL PROTECTED] http://en.wikipedia.org/wiki/Category:Film_directors}
+ */
MOVIE_DIRECTOR,
+ /**
+ * [EMAIL PROTECTED] http://en.wikipedia.org/wiki/Category:News}
+ * @todo rename to NEWS
+ */
NEWSCASE,
+ /**
+ * @deprecated will be removed before sesat-3.0
+ */
NOPICTURE,
+ /**
+ * @deprecated will be removed before sesat-3.0. what words to show a
visual image of is business logic.
+ */
PICTURE,
+ /**
+ * @deprecated the definition of a Prioritised Company is business logic.
+ */
PRIOCOMPANYNAME,
+ /**
+ * [EMAIL PROTECTED] http://en.wikipedia.org/wiki/Category:Cycle_types}
+ * @todo rename to BICYCLE
+ */
PRODUCT_BICYCLE,
+ /**
+ * [EMAIL PROTECTED] http://en.wikipedia.org/wiki/Category:Automobiles}
+ * @todo rename to AUTOMOBILE
+ */
PRODUCT_CAR,
+ /**
+ *
+ */
PRODUCT_CHILDREN,
+ /**
+ * [EMAIL PROTECTED] http://en.wikipedia.org/wiki/Category:Clothing}
+ */
PRODUCT_CLOTHING,
+ /**
+ * [EMAIL PROTECTED] http://en.wikipedia.org/wiki/Category:Construction}
+ * @rename to CONSTRUCTION as not _neccessarily_ related to "construction
equipment"
+ */
PRODUCT_CONSTRUCTION,
+ /**
+ * [EMAIL PROTECTED] http://en.wikipedia.org/wiki/Category:Costume_design}
+ * @todo rename to COSTUME
+ */
PRODUCT_COSTUME,
+ /**
+ * [EMAIL PROTECTED] http://en.wikipedia.org/wiki/Category:Electronics}
+ * @todo rename to ELECTRONIC
+ */
PRODUCT_ELECTRONIC,
+ /**
+ * [EMAIL PROTECTED] http://en.wikipedia.org/wiki/Category:Furniture}
+ * @todo rename to FURNITURE
+ */
PRODUCT_FURNITURE,
+ /**
+ * [EMAIL PROTECTED] http://en.wikipedia.org/wiki/Category:Gardening}
+ * @todo rename to GARDENING
+ */
PRODUCT_GARDEN,
+ /**
+ * [EMAIL PROTECTED] http://en.wikipedia.org/wiki/Category:Hobbies}
+ * @todo rename to HOBBY
+ */
PRODUCT_HOBBY,
+ /**
+ * [EMAIL PROTECTED] http://en.wikipedia.org/wiki/Category:Home}
+ * @todo rename to HOME
+ */
PRODUCT_HOUSEHOLD,
+ /**
+ * [EMAIL PROTECTED] http://en.wikipedia.org/wiki/Category:Jewellery}
+ * @todo rename to JEWELRY
+ */
PRODUCT_JEWELRY,
+ /**
+ * [EMAIL PROTECTED] http://en.wikipedia.org/wiki/Category:Vehicles}
+ * @todo rename to VECHICLE
+ */
PRODUCT_MOTOR,
+ /**
+ * [EMAIL PROTECTED] http://en.wikipedia.org/wiki/Category:Music}
+ * @todo rename to MUSIC
+ */
PRODUCT_MUSIC,
+ /**
+ * @{link http://en.wikipedia.org/wiki/Category:Shoes}
+ * @todo rename to SHOE
+ */
PRODUCT_SHOE,
+ /**
+ * @[EMAIL PROTECTED] http://en.wikipedia.org/wiki/Category:Sports}
+ * @todo rename to SPORT
+ */
PRODUCT_SPORT,
+ /**
+ * [EMAIL PROTECTED] http://en.wikipedia.org/wiki/Category:Watches}
+ * @todo rename to WATCH
+ */
PRODUCT_WATCH,
+ /**
+ * [EMAIL PROTECTED] http://en.wikipedia.org/wiki/Category:Weapons}
+ * @todo rename to WEAPON
+ */
PRODUCT_WEAPON,
+ /**
+ * @deprecated specific to finn.no
+ */
PRODUCT_TORGET,
+ /**
+ * [EMAIL PROTECTED] http://en.wikipedia.org/wiki/Category:Occupations}
+ * @todo rename to OCCUPATION
+ */
PROFESSION,
+ /**
+ * [EMAIL PROTECTED] http://en.wikipedia.org/wiki/Category:Bodies_of_water}
+ */
OCEAN,
+ /**
+ * [EMAIL PROTECTED]
http://en.wikipedia.org/wiki/Category:Security_identifier_types}
+ * @todo rename to STOCK_SYMBOL
+ */
STOCKMARKETTICKERS,
+ /**
+ * [EMAIL PROTECTED]
http://en.wikipedia.org/wiki/Category:Publicly_traded_companies}
+ * @todo rename to PUBLIC_COMPANY
+ */
STOCKMARKETFIRMS,
+ /**
+ * [EMAIL PROTECTED] http://en.wikipedia.org/wiki/Category:Genres}
+ * @todo rename to GENRE
+ */
STYLE,
+ /**
+ * @deprecated will be remove before sesat-3.0. a list of locally popular
commercial websites is business related.
+ */
TNS,
+ /**
+ * [EMAIL PROTECTED]
http://en.wikipedia.org/wiki/Category:Television_programming}
+ */
TVPROGRAM,
+ /**
+ * [EMAIL PROTECTED]
http://en.wikipedia.org/wiki/Category:Television_stations}
+ */
TVCHANNEL,
+ /**
+ * [EMAIL PROTECTED] http://en.wikipedia.org/wiki/Category:Trademarks}
+ */
TRADEMARK,
+ /**
+ * [EMAIL PROTECTED] http://en.wikipedia.org/wiki/Category:Wikipedia}
+ */
WIKIPEDIA,
+ /**
+ * [EMAIL PROTECTED] http://en.wikipedia.org/wiki/Category:Artists}
+ */
ARTIST,
+ /**
+ * [EMAIL PROTECTED]
http://en.wikipedia.org/wiki/Category:Fictional_characters}
+ */
FICTION_CHARACTER,
+ /**
+ * [EMAIL PROTECTED] http://en.wikipedia.org/wiki/Category:Motorsport}
+ */
MOTOR_SPORT,
+ /**
+ * [EMAIL PROTECTED]
http://en.wikipedia.org/wiki/Category:Publicly_funded_broadcasters}
+ * @deprecated will be removed before sesat-3.0. use anonymous or see
#TVPROGRAM
+ */
PUBLIC_SERVICE_BROADCASTING,
+ /**
+ * @deprecated will be removed before sesat-3.0. what words to show a
visual image of is business logic.
+ */
IMAGES,
+ /**
+ * @deprecated not a category, but a keyword used as a portal into another
search mode
+ */
BOOK_MAGIC,
+ /**
+ *
+ * @deprecated not a category, but a keyword used as a portal into another
search mode
+ */
CATALOGUE_MAGIC,
+ /**
+ *
+ * @deprecated not a category, but a keyword used as a portal into another
search mode
+ */
CLASSIFIED_MAGIC,
+ /**
+ *
+ * @deprecated not a category, but a keyword used as a portal into another
search mode
+ */
CULTURE_MAGIC,
+ /**
+ *
+ * @deprecated not a category, but a keyword used as a portal into another
search mode
+ */
MOVIE_MAGIC,
+ /**
+ *
+ * @deprecated not a category, but a keyword used as a portal into another
search mode
+ */
NEWS_MAGIC,
+ /**
+ *
+ * @deprecated not a category, but a keyword used as a portal into another
search mode
+ */
OCEAN_MAGIC,
+ /**
+ * @deprecated not a category, but a keyword used as a portal into another
search mode
+ */
PICTURE_MAGIC,
+ /**
+ * @deprecated not a category, but a keyword used as a portal into another
search mode
+ */
VIDEO_MAGIC,
+ /**
+ * @deprecated not a category, but a keyword used as a portal into another
search mode
+ */
RECEIPE_MAGIC,
+ /**
+ * @deprecated not a category, but a keyword used as a portal into another
search mode
+ */
SKIINFO_MAGIC,
+ /**
+ * @deprecated not a category, but a keyword used as a portal into another
search mode
+ */
STOCK_MAGIC,
+ /**
+ * @deprecated not a category, but a keyword used as a portal into another
search mode
+ */
TV_MAGIC,
+ /**
+ * @deprecated not a category, but a keyword used as a portal into another
search mode
+ */
WEATHER_MAGIC,
+ /**
+ * @deprecated not a category, but a keyword used as a portal into another
search mode
+ */
WEBTV_MAGIC,
+ /**
+ * @deprecated not a category, but a keyword used as a portal into another
search mode
+ */
WHITE_MAGIC,
+ /**
+ * @deprecated not a category, but a keyword used as a portal into another
search mode
+ */
WIKIPEDIA_MAGIC,
+ /**
+ * @deprecated not a category, but a keyword used as a portal into another
search mode
+ */
YELLOW_MAGIC,
+ /**
+ * @deprecated not a category, but a keyword used as a portal into another
search mode
+ */
MAP_MAGIC,
+ /**
+ * @deprecated not a category, but a keyword used as a portal into another
search mode
+ */
BLOG_MAGIC,
+ /**
+ * @deprecated not a category, but keywords used as a portal into another
search mode
+ */
CATALOGUE_TRIGGER,
+ /**
+ * @deprecated not a category, but keywords used as a portal into another
search mode
+ */
CLASSIFIED_TRIGGER,
+ /**
+ * @deprecated not a category, but keywords used as a portal into another
search mode
+ */
LOAN_TRIGGER,
+ /**
+ * @deprecated not a category, but keywords used as a portal into another
search mode
+ */
NEWS_TRIGGER,
+ /**
+ * @deprecated not a category, but keywords used as a portal into another
search mode
+ */
OCEAN_TRIGGER,
+ /**
+ * @deprecated not a category, but keywords used as a portal into another
search mode
+ */
PICTURE_TRIGGER,
+ /**
+ * @deprecated not a category, but keywords used as a portal into another
search mode
+ */
VIDEO_TRIGGER,
+ /**
+ * @deprecated not a category, but keywords used as a portal into another
search mode
+ */
SKIINFO_TRIGGER,
+ /**
+ * @deprecated not a category, but keywords used as a portal into another
search mode
+ */
SUDOKU_TRIGGER,
+ /**
+ * @deprecated not a category, but keywords used as a portal into another
search mode
+ */
TV_TRIGGER,
+ /**
+ * @deprecated not a category, but keywords used as a portal into another
search mode
+ */
WEATHER_TRIGGER,
+ /**
+ * @deprecated not a category, but keywords used as a portal into another
search mode
+ */
WIKIPEDIA_TRIGGER,
+ /**
+ * @deprecated inappropriate method to determine if the "site:" field has
been applied to a term.
+ */
SITEPREFIX,
+ /** While not exactly matching the "Types of Companies" category
+ * [EMAIL PROTECTED]
http://en.wikipedia.org/wiki/Category:Types_of_companies}
+ * it does intend to provide a list of abbreviations commonly used to
identify
+ * these difference types of companies
+ */
COMPANYSUFFIX,
+ /**
+ * Each country has a different format in its company/organisation numbers.
+ * For example in norway organisation numbers are always nine digits.
+ */
ORGNR,
+ /**
+ * Each country has a different format for phone numbers.
+ * The query parser has a very generic test for matching phone numbers
that appear in any country.
+ * This Category can be used to further test against a particular
country's format.
+ */
PHONENUMBER,
+ /**
+ * @deprecated will be removed before sesat-3.0
+ */
ONLYSKIINFO,
+ /**
+ * A completely empty query.
+ */
EMPTYQUERY,
+ /**
+ * [EMAIL PROTECTED] http://en.wikipedia.org/wiki/Category:Equations}
+ */
MATHPREDICATE;
private final TokenPredicateImpl impl;
_______________________________________________
Kernel-commits mailing list
[email protected]
http://sesat.no/mailman/listinfo/kernel-commits
