Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: documentation for search related classes #102

Merged
merged 1 commit into from
Jun 27, 2022
Merged

docs: documentation for search related classes #102

merged 1 commit into from
Jun 27, 2022

Conversation

adilansari
Copy link
Contributor

  • Javadocs for /search builder classes

@codecov-commenter
Copy link

codecov-commenter commented Jun 24, 2022 •
edited
Loading

Codecov Report

Merging #102 (14bb194) into main (12fb968) will decrease coverage by 0.00%.
The diff coverage is 87.50%.

@@             Coverage Diff              @@
##               main     #102      +/-   ##
============================================
- Coverage     82.81%   82.80%   -0.01%     
  Complexity      556      556              
============================================
  Files            67       67              
  Lines          1740     1739       -1     
  Branches        150      149       -1     
============================================
- Hits           1441     1440       -1     
  Misses          275      275              
  Partials         24       24
Impacted Files Coverage Δ
...va/com/tigrisdata/db/client/search/FacetCount.java 100.00% <ø> (ø)
...sdata/db/client/search/FacetCountDistribution.java 100.00% <ø> (ø)
...tigrisdata/db/client/search/FacetQueryOptions.java 100.00% <ø> (ø)
...va/com/tigrisdata/db/client/search/FacetStats.java 100.00% <ø> (ø)
...main/java/com/tigrisdata/db/client/search/Hit.java 95.83% <ø> (ø)
.../com/tigrisdata/db/client/search/SearchFields.java 92.85% <ø> (ø)
...va/com/tigrisdata/db/client/search/SearchMeta.java 100.00% <ø> (ø)
...risdata/db/client/search/SearchRequestOptions.java 100.00% <ø> (ø)
.../com/tigrisdata/db/client/search/SearchResult.java 100.00% <ø> (ø)
...com/tigrisdata/db/client/search/SearchRequest.java 93.33% <75.00%> (ø)
... and 2 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 12fb968...14bb194. Read the comment docs.

@JigarJoshi
Copy link
Collaborator

Javadoc generation fails with

[ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:3.3.2:jar (attach-javadocs) on project tigris-client: MavenReportException: Error while generating Javadoc:
[ERROR] Exit code: 1 - /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/TigrisCollection.java:100: warning: no @throws for com.tigrisdata.db.client.error.TigrisException
[ERROR]   Iterator<SearchResult<T>> search(SearchRequest request) throws TigrisException;
[ERROR]                             ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/FacetCount.java:32: warning: no @return
[ERROR]   public String getValue() {
[ERROR]                 ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/FacetCount.java:37: warning: no @return
[ERROR]   public long getCount() {
[ERROR]               ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/FacetCountDistribution.java:38: error: type arguments not allowed here
[ERROR]    * @return immutable {@link List<FacetCount>}
[ERROR]                               ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/FacetCountDistribution.java:45: warning: no @return
[ERROR]   public FacetStats getStats() {
[ERROR]                     ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/FacetCountDistribution.java:40: warning - Tag @link:illegal character: "60" in "List<FacetCount>"
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/FacetCountDistribution.java:40: warning - Tag @link:illegal character: "62" in "List<FacetCount>"
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/FacetFieldsQuery.java:121: warning: no @return
[ERROR]     public Builder withField(String field) {
[ERROR]                    ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/FacetFieldsQuery.java:135: warning: no @return
[ERROR]     public Builder withFieldOptions(String field, FacetQueryOptions options) {
[ERROR]                    ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/FacetFieldsQuery.java:144: warning: no @return
[ERROR]     public Builder addAll(Map<String, FacetQueryOptions> fieldOptions) {
[ERROR]                    ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/FacetFieldsQuery.java:153: warning: no @return
[ERROR]     public FacetFieldsQuery build() {
[ERROR]                             ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/FacetQueryOptions.java:62: warning: no @return
[ERROR]   public FacetFieldType getType() {
[ERROR]                         ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/FacetQueryOptions.java:67: warning: no @return
[ERROR]   public long getSize() {
[ERROR]               ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/FacetQueryOptions.java:128: warning: no @param for type
[ERROR]     public Builder withType(FacetFieldType type) {
[ERROR]                    ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/FacetQueryOptions.java:128: warning: no @return
[ERROR]     public Builder withType(FacetFieldType type) {
[ERROR]                    ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/FacetQueryOptions.java:134: warning: no @param for size
[ERROR]     public Builder withSize(long size) {
[ERROR]                    ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/FacetQueryOptions.java:134: warning: no @return
[ERROR]     public Builder withSize(long size) {
[ERROR]                    ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/FacetQueryOptions.java:140: warning: no @return
[ERROR]     public FacetQueryOptions build() {
[ERROR]                              ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/FacetStats.java:38: warning: no @return
[ERROR]   public long getCount() {
[ERROR]               ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/FacetStats.java:43: warning: no @return
[ERROR]   public double getAvg() {
[ERROR]                 ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/FacetStats.java:48: warning: no @return
[ERROR]   public long getMax() {
[ERROR]               ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/FacetStats.java:53: warning: no @return
[ERROR]   public long getMin() {
[ERROR]               ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/FacetStats.java:58: warning: no @return
[ERROR]   public long getSum() {
[ERROR]               ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/Hit.java:42: warning: no @return
[ERROR]   public T getDocument() {
[ERROR]            ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/Hit.java:47: warning: no @return
[ERROR]   public HitMeta getMeta() {
[ERROR]                  ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/QueryString.java:35: warning: no @return
[ERROR]   public static QueryString getMatchAllQuery() {
[ERROR]                             ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/QueryString.java:40: warning: no @return
[ERROR]   public String getQ() {
[ERROR]                 ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/QueryString.java:73: warning: no @return
[ERROR]   public static Builder newBuilder(String q) {
[ERROR]                         ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/QueryString.java:86: warning: no @return
[ERROR]     public QueryString build() {
[ERROR]                        ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/SearchFields.java:94: warning: no @return
[ERROR]     public Builder withField(String field) {
[ERROR]                    ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/SearchFields.java:107: warning: no @return
[ERROR]     public Builder withFields(Collection<? extends String> fields) {
[ERROR]                    ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/SearchFields.java:116: warning: no @return
[ERROR]     public SearchFields build() {
[ERROR]                         ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/SearchMeta.java:36: warning: no @return
[ERROR]   public long getFound() {
[ERROR]               ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/SearchMeta.java:41: warning: no @return
[ERROR]   public long getCurrentPage() {
[ERROR]               ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/SearchMeta.java:46: warning: no @return
[ERROR]   public long getTotalPages() {
[ERROR]               ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/SearchMeta.java:51: warning: no @return
[ERROR]   public int getPerPage() {
[ERROR]              ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/SearchRequest.java:51: warning: no @return
[ERROR]   public Query getQuery() {
[ERROR]                ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/SearchRequest.java:56: warning: no @return
[ERROR]   public SearchFields getSearchFields() {
[ERROR]                       ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/SearchRequest.java:61: warning: no @return
[ERROR]   public TigrisFilter getFilter() {
[ERROR]                       ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/SearchRequest.java:66: warning: no @return
[ERROR]   public FacetQuery getFacetQuery() {
[ERROR]                     ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/SearchRequest.java:71: warning: no @return
[ERROR]   public SortOrders getSortOrders() {
[ERROR]                     ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/SearchRequest.java:76: warning: no @return
[ERROR]   public ReadFields getReadFields() {
[ERROR]                     ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/SearchRequest.java:94: warning: no @param for fields
[ERROR]     public Builder withSearchFields(SearchFields fields) {
[ERROR]                    ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/SearchRequest.java:94: warning: no @return
[ERROR]     public Builder withSearchFields(SearchFields fields) {
[ERROR]                    ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/SearchRequest.java:99: warning: no @param for filter
[ERROR]     public Builder withFilter(TigrisFilter filter) {
[ERROR]                    ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/SearchRequest.java:99: warning: no @return
[ERROR]     public Builder withFilter(TigrisFilter filter) {
[ERROR]                    ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/SearchRequest.java:104: warning: no @param for facetQuery
[ERROR]     public Builder withFacetQuery(FacetQuery facetQuery) {
[ERROR]                    ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/SearchRequest.java:104: warning: no @return
[ERROR]     public Builder withFacetQuery(FacetQuery facetQuery) {
[ERROR]                    ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/SearchRequest.java:109: warning: no @param for sortOrders
[ERROR]     public Builder withSortOrders(SortOrders sortOrders) {
[ERROR]                    ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/SearchRequest.java:109: warning: no @return
[ERROR]     public Builder withSortOrders(SortOrders sortOrders) {
[ERROR]                    ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/SearchRequest.java:115: warning: no @param for fields
[ERROR]     public Builder withReadFields(ReadFields fields) {
[ERROR]                    ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/SearchRequest.java:115: warning: no @return
[ERROR]     public Builder withReadFields(ReadFields fields) {
[ERROR]                    ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/SearchRequest.java:125: warning: no @return
[ERROR]     public SearchRequest build() {
[ERROR]                          ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/SearchRequestOptions.java:32: warning: no @return
[ERROR]   public long getPage() {
[ERROR]               ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/SearchRequestOptions.java:37: warning: no @return
[ERROR]   public long getPerPage() {
[ERROR]               ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/SearchRequestOptions.java:43: error: tag not allowed here: <li>
[ERROR]    * <li>Page numbers start at `1` for first page
[ERROR]      ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/SearchRequestOptions.java:44: error: tag not allowed here: <li>
[ERROR]    * <li>By default 10 results will be fetched per page
[ERROR]      ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/SearchRequestOptions.java:46: warning: no @return
[ERROR]   public static SearchRequestOptions getDefault() {
[ERROR]                                      ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/SearchRequestOptions.java:75: warning: no @return
[ERROR]   public static Builder newBuilder() {
[ERROR]                         ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/SearchRequestOptions.java:89: warning: no @param for page
[ERROR]     public Builder withPage(long page) {
[ERROR]                    ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/SearchRequestOptions.java:89: warning: no @return
[ERROR]     public Builder withPage(long page) {
[ERROR]                    ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/SearchRequestOptions.java:95: warning: no @param for perPage
[ERROR]     public Builder withPerPage(long perPage) {
[ERROR]                    ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/SearchRequestOptions.java:95: warning: no @return
[ERROR]     public Builder withPerPage(long perPage) {
[ERROR]                    ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/SearchRequestOptions.java:101: warning: no @return
[ERROR]     public SearchRequestOptions build() {
[ERROR]                                 ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/SearchResult.java:48: warning: no @return
[ERROR]   public List<Hit<T>> getHits() {
[ERROR]                       ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/SearchResult.java:53: warning: no @return
[ERROR]   public Map<String, FacetCountDistribution> getFacets() {
[ERROR]                                              ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/SearchResult.java:58: warning: no @return
[ERROR]   public SearchMeta getMeta() {
[ERROR]                     ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/SearchResult.java:70: warning: no @return
[ERROR]   public static <R extends TigrisCollectionType> SearchResult<R> from(
[ERROR]                                                                  ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/SearchResult.java:29: error: tag not allowed here: <li>
[ERROR]  * <li>Representation of {@link Api.SearchResponse} from server
[ERROR]    ^
[ERROR] /Users/jmj/projects/tigris-client-java/client/src/main/java/com/tigrisdata/db/client/search/SearchResult.java:30: error: unexpected end tag: </ul>
[ERROR]  * </ul>
[ERROR]    ^
[ERROR]
[ERROR] Command line was: /Users/jmj/Library/Java/JavaVirtualMachines/liberica-1.8.0_322/jre/../bin/javadoc @options @packages
[ERROR]
[ERROR] Refer to the generated Javadoc files in '/Users/jmj/projects/tigris-client-java/client/target/apidocs' dir.

We need to add Javadoc as part of CI but for now you can reproduce it using

mvn clean install javadoc:javadoc -P publish

@adilansari
Copy link
Contributor Author

Fixed the javadoc generation

@adilansari adilansari merged commit 7d658d3 into main Jun 27, 2022
@adilansari adilansari deleted the search-docs branch June 27, 2022 17:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JigarJoshi JigarJoshi JigarJoshi approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@adilansari @codecov-commenter @JigarJoshi