Browse Source

修改接口注释

sunyj 8 years ago
parent
commit
6558a682f5

+ 31 - 8
search-api/src/main/java/com/uas/search/service/OrderSearchService.java

@@ -68,14 +68,37 @@ public interface OrderSearchService {
 	 *            {@link com.uas.search.model.PageParams.FilterField},值的类型由键决定:
 	 *            </p>
 	 * 
-	 *            <PRE>
-	 *            ORDER_STATUS: Integer的List列表,多个状态之间取"或"的关系
-	 *            ORDER_BUYER_UU: Long
-	 *            ORDER_BUYER_EN_UU: Long
-	 *            ORDER_SELLER_EN_UU: Long
-	 *            ORDER_MIN_TIME: Long
-	 *            ORDER_MAX_TIME: Long
-	 *            </PRE>
+	 *            <table border=1 cellpadding=5 cellspacing=0 summary=
+	 *            "Fields and types">
+	 *            <tr>
+	 *            <th>Field</th>
+	 *            <th>Type</th>
+	 *            </tr>
+	 *            <tr>
+	 *            <td>ORDER_STATUS</td>
+	 *            <td>List(Integer),多个状态之间取"或"的关系</td>
+	 *            </tr>
+	 *            <tr>
+	 *            <td>ORDER_BUYER_UU</td>
+	 *            <td>Long</td>
+	 *            </tr>
+	 *            <tr>
+	 *            <td>ORDER_BUYER_EN_UU</td>
+	 *            <td>Long</td>
+	 *            </tr>
+	 *            <tr>
+	 *            <td>ORDER_SELLER_EN_UU</td>
+	 *            <td>Long</td>
+	 *            </tr>
+	 *            <tr>
+	 *            <td>ORDER_MIN_TIME</td>
+	 *            <td>Long</td>
+	 *            </tr>
+	 *            <tr>
+	 *            <td>ORDER_MAX_TIME</td>
+	 *            <td>Long</td>
+	 *            </tr>
+	 *            </table>
 	 * 
 	 * @return 符合条件的单据。<br>
 	 *         如果关键词命中主表中的信息,结果有主表信息不带从表;<br>

+ 120 - 31
search-api/src/main/java/com/uas/search/service/SearchService.java

@@ -67,15 +67,41 @@ public interface SearchService {
 	 *            {@link com.uas.search.model.PageParams.FilterField},值的类型由键决定:
 	 *            </p>
 	 * 
-	 *            <PRE>
-	 *            COMPONENT_KINDID: Long
-	 *            COMPONENT_BRANDID: Long
-	 *            COMPONENT_PROPERTIES: 键值对,键值分别为属性id、属性值
-	 *            COMPONENT_HAS_RESERVE: Boolean
-	 *            COMPONENT_HAS_SAMPLE: Boolean
-	 *            COMPONENT_HAS_ORIGINAL: Boolean
-	 *            COMPONENT_HAS_INACTION_STOCK: Boolean
-	 *            </PRE>
+	 *            <table border=1 cellpadding=5 cellspacing=0 summary=
+	 *            "Fields and types">
+	 *            <tr>
+	 *            <th>Field</th>
+	 *            <th>Type</th>
+	 *            </tr>
+	 *            <tr>
+	 *            <td>COMPONENT_KINDID</td>
+	 *            <td>Long</td>
+	 *            </tr>
+	 *            <tr>
+	 *            <td>COMPONENT_BRANDID</td>
+	 *            <td>Long</td>
+	 *            </tr>
+	 *            <tr>
+	 *            <td>COMPONENT_PROPERTIES</td>
+	 *            <td>键值对,键值分别为属性id、属性值</td>
+	 *            </tr>
+	 *            <tr>
+	 *            <td>COMPONENT_HAS_RESERVE</td>
+	 *            <td>Boolean</td>
+	 *            </tr>
+	 *            <tr>
+	 *            <td>COMPONENT_HAS_SAMPLE</td>
+	 *            <td>Boolean</td>
+	 *            </tr>
+	 *            <tr>
+	 *            <td>COMPONENT_HAS_ORIGINAL</td>
+	 *            <td>Boolean</td>
+	 *            </tr>
+	 *            <tr>
+	 *            <td>COMPONENT_HAS_INACTION_STOCK</td>
+	 *            <td>Boolean</td>
+	 *            </tr>
+	 *            </table>
 	 * 
 	 * @return
 	 * @throws SearchException
@@ -210,16 +236,45 @@ public interface SearchService {
 	 *            {@link com.uas.search.model.PageParams.FilterField},值的类型由键决定:
 	 *            </p>
 	 * 
-	 *            <PRE>
-	 *            GOODS_KINDID: List(Long)
-	 *            GOODS_BRANDID: List(Long)
-	 *            GOODS_STORE_TYPE: List(String)
-	 *            GOODS_CRNAME: List(String)
-	 *            GOODS_MINPRICERMB: Double
-	 *            GOODS_MAXPRICERMB: Double
-	 *            GOODS_MINPRICEUSD: Double
-	 *            GOODS_MAXPRICEUSD: Double
-	 *            </PRE>
+	 *            <table border=1 cellpadding=5 cellspacing=0 summary=
+	 *            "Fields and types">
+	 *            <tr>
+	 *            <th>Field</th>
+	 *            <th>Type</th>
+	 *            </tr>
+	 *            <tr>
+	 *            <td>GOODS_KINDID</td>
+	 *            <td>List(Long)</td>
+	 *            </tr>
+	 *            <tr>
+	 *            <td>GOODS_BRANDID</td>
+	 *            <td>List(Long)</td>
+	 *            </tr>
+	 *            <tr>
+	 *            <td>GOODS_STORE_TYPE</td>
+	 *            <td>List(String)</td>
+	 *            </tr>
+	 *            <tr>
+	 *            <td>GOODS_CRNAME</td>
+	 *            <td>List(String)</td>
+	 *            </tr>
+	 *            <tr>
+	 *            <td>GOODS_MINPRICERMB</td>
+	 *            <td>Double</td>
+	 *            </tr>
+	 *            <tr>
+	 *            <td>GOODS_MAXPRICERMB</td>
+	 *            <td>Double</td>
+	 *            </tr>
+	 *            <tr>
+	 *            <td>GOODS_MINPRICEUSD</td>
+	 *            <td>Double</td>
+	 *            </tr>
+	 *            <tr>
+	 *            <td>GOODS_MAXPRICEUSD</td>
+	 *            <td>Double</td>
+	 *            </tr>
+	 *            </table>
 	 * 
 	 * @return 器件id、批次id和分页信息
 	 */
@@ -235,21 +290,55 @@ public interface SearchService {
 	 * @param filters
 	 *            过滤条件,值的类型由键决定:
 	 * 
-	 *            <PRE>
-	 *            GOODS_KINDID: List(Long)
-	 *            GOODS_BRANDID: List(Long)
-	 *            GOODS_STORE_TYPE: List(String)
-	 *            GOODS_CRNAME: List(String)
-	 *            </PRE>
+	 *            <table border=1 cellpadding=5 cellspacing=0 summary=
+	 *            "Fields and types">
+	 *            <tr>
+	 *            <th>Field</th>
+	 *            <th>Type</th>
+	 *            </tr>
+	 *            <tr>
+	 *            <td>GOODS_KINDID</td>
+	 *            <td>List(Long)</td>
+	 *            </tr>
+	 *            <tr>
+	 *            <td>GOODS_BRANDID</td>
+	 *            <td>List(Long)</td>
+	 *            </tr>
+	 *            <tr>
+	 *            <td>GOODS_STORE_TYPE</td>
+	 *            <td>List(String)</td>
+	 *            </tr>
+	 *            <tr>
+	 *            <td>GOODS_CRNAME</td>
+	 *            <td>List(String)</td>
+	 *            </tr>
+	 *            </table>
 	 * 
 	 * @return 统计的信息(由collectedField决定)
 	 * 
-	 *         <PRE>
-	 *            GOODS_KIND: ki_id、ki_name_cn
-	 *            GOODS_BRAND: br_id、br_uuid、br_name_cn、br_name_en
-	 *            GOODS_STORE_TYPE: store_type
-	 *            GOODS_CRNAME: cr_name
-	 *         </PRE>
+	 *         <table border=1 cellpadding=5 cellspacing=0 summary=
+	 *         "Collected fields and messages">
+	 *         <tr>
+	 *         <th>Collected field</th>
+	 *         <th>Message</th>
+	 *         </tr>
+	 *         <tr>
+	 *         <td>GOODS_KIND</td>
+	 *         <td>ki_id、ki_name_cn</td>
+	 *         </tr>
+	 *         <tr>
+	 *         <td>GOODS_BRAND</td>
+	 *         <td>br_id、br_uuid、br_name_cn、br_name_en</td>
+	 *         </tr>
+	 *         <tr>
+	 *         <td>GOODS_STORE_TYPE</td>
+	 *         <td>store_type</td>
+	 *         </tr>
+	 *         <tr>
+	 *         <td>GOODS_CRNAME</td>
+	 *         <td>cr_name</td>
+	 *         </tr>
+	 *         </table>
 	 */
 	public List<Map<String, Object>> collectBySearchGoods(String keyword, CollectField collectedField,
 			Map<FilterField, Object> filters);