001: /*
002: * Copyright 2001 Sun Microsystems, Inc. All rights reserved.
003: * PROPRIETARY/CONFIDENTIAL. Use of this product is subject to license terms.
004: */
005:
006: package com.sun.portal.search.rdm;
007:
008: /**
009: * RDM Definitions (Resource Description Messaging)
010: *
011: * <p> For further details: http://www.w3.org/pub/WWW/TR/NOTE-rdm.html
012: */
013: public interface RDM {
014:
015: // Used for CSID types
016: int CSID_UNDEF = 0; // unknown
017: int CSID_NORMAL = 1; // x-catalog
018: int CSID_SSL = 2; // x-catalogs
019:
020: // Used for Taxonomy traversals
021: int RDM_TAX_INORDER = 0;
022: int RDM_TAX_PREORDER = 1;
023: int RDM_TAX_POSTORDER = 2;
024:
025: // Used for RDMViewOrder
026: int RDM_ASCENDING = 0;
027: int RDM_DESCENDING = 1;
028:
029: String RDM_MSGTYPE_UNKNOWN = "unknown";
030: String RDM_RD_REQ = "rd-request";
031: String RDM_RD_RES = "rd-response";
032: String RDM_RD_UPD_REQ = "rd-update-request";
033: String RDM_RD_UPD_RES = "rd-update-response";
034: String RDM_RD_DEL_REQ = "rd-delete-request";
035: String RDM_RD_DEL_RES = "rd-delete-response";
036: String RDM_RD_SUBMIT_REQ = "rd-submit-request"; // 6.0
037: String RDM_RD_SUBMIT_RES = "rd-submit-response"; // 6.0
038: String RDM_SD_REQ = "server-description-request";
039: String RDM_SD_RES = "server-description-response";
040: String RDM_SCH_REQ = "schema-description-request";
041: String RDM_SCH_RES = "schema-description-response";
042: String RDM_TAX_REQ = "taxonomy-description-request";
043: String RDM_TAX_RES = "taxonomy-description-response";
044: String RDM_STAT_REQ = "status-request";
045: String RDM_STAT_RES = "status-response";
046:
047: String RDM_SD_REQ_LEGACY = "server-request";
048: String RDM_SD_RES_LEGACY = "server-response";
049: String RDM_SCH_REQ_LEGACY = "schema-request";
050: String RDM_SCH_RES_LEGACY = "schema-response";
051: String RDM_TAX_REQ_LEGACY = "taxonomy-request";
052: String RDM_TAX_RES_LEGACY = "taxonomy-response";
053:
054: /** RDM MIME type for use with HTTP/1.0 */
055: //String RDM_MIME_TYPE = "application/x-rdm"; // CS1.0
056: String RDM_MIME_TYPE = "text/plain; charset=utf-8"; // 6.0
057:
058: /** RDM Header - @RDMHEADER SOIF attribute names */
059: String A_RDM_VERSION = "rdm-version"; // CS1.0
060: String A_RDM_TYPE = "rdm-type"; // CS1.0
061: String A_RDM_QL = "rdm-query-language"; // CS1.0
062: String A_RDM_RESP = "rdm-response-interpret"; // CS1.0
063: String A_RDM_EMSG = "rdm-error-message"; // CS1.0
064: String A_RDM_ERR = "rdm-error-number"; // CS1.0
065: String A_RDM_CSID = "catalog-service-id"; // CS1.0
066: String A_RDM_ACCESS_TOKEN = "rdm-access-token"; // 6.0
067: String A_RDM_USER = "rdm-user"; // 6.0
068: String A_RDM_PASSWORD = "rdm-password"; // 6.0
069:
070: /** RDM Query - @RDMQUERY SOIF attribute names */
071: String A_RDM_SCOPE = "scope"; // CS1.0
072: String A_RDM_MODE = "mode"; // CS3.01C
073: String A_RDM_VIEWATT = "view-attributes"; // CS1.0
074: String A_RDM_VIEWHIT = "view-hits"; // CS1.0
075: String A_RDM_VIEWORD = "view-order"; // CS1.0
076: String A_RDM_DATABASE = "database"; // 6.0
077: String A_RDM_HIGHLIGHT = "highlight"; // 6.0
078: String A_RDM_HIGHLIGHT_TAGS = "highlight-tags"; // 6.0
079: String A_RDM_HIGHLIGHT_TAGS_FIELD = "highlight-tags-field"; // 6.0
080: String A_RDM_SEARCH_CATEGORY = "search-category"; // 6.0
081: String A_RDM_PASSAGE_CONTEXT = "passage-context"; // 6.0
082: String A_RDM_MAX_PASSAGES = "max-passags"; // 6.0
083:
084: /** RDM Classification/Taxonomy - SOIF attribute names */
085: String A_RDM_ID = "id"; // CS1.0
086: String A_RDM_PARENT = "parent-id"; // CS1.0
087: String A_RDM_TAX = "taxonomy-id"; // CS1.0
088: String A_RDM_DESC = "description"; // CS1.0
089: String A_RDM_XREF = "cross-reference-to"; // CS2.0
090: String A_RDM_LMT = "last-modified"; // CS1.0
091: String A_RDM_MAINT = "maintainer"; // CS1.0
092: String A_RDM_MATCHRULE = "matching-rule"; // CS2.0
093: String A_RDM_NSUBCAT = "subclassification-count"; // CS2.0
094: String A_RDM_NCATDOC = "categorized-count"; // CS2.0
095: String A_RDM_NSUBDOC = "subcategorized-count"; // CS3.01C
096: String A_RDM_CHILD = "child"; // CS3.01C
097:
098: /** RDM Schema - SOIF attribute names */
099: String A_RDM_SDL_VERSION = "schema-definition-language-version"; // CS1.0
100: String A_RDM_SCHEMA_NAME = "schema-name"; // CS1.0
101: String A_RDM_NUM_ENTRIES = "number-of-entries"; // CS1.0
102: String A_RDM_SOIF_ATTR = "soif-attribute"; // CS1.0
103: String A_RDM_DESC_ATTR = "description"; // CS1.0
104: String A_RDM_DATA_TYPE = "data-type"; // CS1.0
105: String A_RDM_CONTENT_TYPE = "content-type"; // CS1.0
106: String A_RDM_CONTENT_ENCODING = "content-encoding"; // 6.0
107: String A_RDM_CONTENT_LANGUAGE = "content-langauge"; // 6.0
108: String A_RDM_CONTENT_LENGTH = "content-length"; // 6.0
109: String A_RDM_CONTENT_CHARSET = "content-charset"; // 6.0
110: String A_RDM_ENFORCE_UNIQ = "enforce-uniqueness"; // CS1.0
111: String A_RDM_INDEX_ATTR = "index-attribute"; // CS1.0
112: String A_RDM_DB_INDEX_ATTR = "db-index-attribute"; // CS2.0
113: String A_RDM_EDIT_ATTR = "edit-attribute"; // CS2.0
114: String A_RDM_INTERNAL = "is-internal"; // CS1.0
115: String A_RDM_VIEWORD_DEFAULT = "default-view-order"; // CS1.0
116: String A_RDM_VIEWATT_DEFAULT = "default-view-attribute"; // CS1.0
117: String A_RDM_TBLNAME = "table-name"; // CS1.0
118: String A_RDM_COLNAME = "column-name"; // CS1.0
119: String A_RDM_SYSTBLNAME = "system-table-name"; // CS1.0
120: String A_RDM_SYSCOLNAME = "system-column-name"; // CS1.0
121: String A_RDM_FK_SYSTBLNAME = "foreign-key-system-table-name"; // CS1.0
122: String A_RDM_FK_SYSCOLNAME = "foreign-key-system-column-name"; // CS1.0
123: String A_RDM_INROOT = "in-root-table"; // CS1.0
124: String A_RDM_ALERTABLE = "is-alertable"; // 6.0
125: String A_RDM_ALIASES = "aliases"; // 6.0 - alias1, alias2, alias3...
126: String A_RDM_SCORE_MULTIPLIER = "score-multiplier"; // 6.1 - search score multiplier for hits in a field
127:
128: /** RDM Server - SOIF attribute names */
129: String A_RDM_SUPTYPE = "supported-rdm-type"; // CS1.0
130: String A_RDM_SUPQL = "supported-rdm-query-language"; // CS1.0
131: String A_RDM_SUPCSID = "supported-catalog-service-id"; // CS1.0
132: String A_RDM_SD_LMT = "sd-last-modified"; // CS1.0
133: String A_RDM_SD_EXPIRE = "sd-expires"; // CS1.0
134: String A_RDM_SAMPLE_RD = "sample-rd"; // CS1.0
135: String A_RDM_COLL = "collection"; // Ent3.0
136:
137: /** SOIF schema names for all RDM objects */
138: String A_SN_RDM_CLASS = "CLASSIFICATION"; // CS1.0
139: String A_SN_RDM_TAX = "TAXONOMY"; // CS1.0
140: String A_SN_RDM_SCHEMA = "SCHEMA"; // CS1.0
141: String A_SN_RDM_HDR = "RDMHEADER"; // CS1.0
142: String A_SN_RDM_QRY = "RDMQUERY"; // CS1.0
143: String A_SN_RDM_SERVER = "RDMSERVER"; // CS1.0
144:
145: /** submit protocol */
146: // CS3.01Csp1
147: String SUBMIT_RESPONSE = "Response";
148: String SUBMIT_REQUEST = "Request";
149: String SUBMIT_ERROR = "Error";
150: String SUBMIT_CSID = "submit-csid";
151: String SUBMIT_TYPE = "submit-type";
152: String SUBMIT_OPER = "submit-operation";
153: String SUBMIT_VIEW = "submit-view";
154: String SUBMIT_DB = "submit-database";
155: String SUBMIT_MESSAGE = "message";
156:
157: /** submit types */
158: String SUBMIT_PERSISTENT = "persistent";
159: String SUBMIT_NONPERSISTENT = "nonpersistent";
160: String SUBMIT_MERGED = "merged";
161:
162: /** submit operations */
163: String SUBMIT_RETRIEVE = "retrieve";
164: String SUBMIT_INSERT = "insert";
165: String SUBMIT_DELETE = "delete";
166: String SUBMIT_MERGE = "merge";
167: String SUBMIT_UPDATE = "update";
168:
169: }
|