Search samples

Basics

Almosts all methods use QueryParams. Here there're some tips about how using it.

Variables	Type	Allow wildcards	Restrictions	Description
domain	long	No.	Available values: QueryParams.DOCUMENT QueryParams.FOLDER QueryParams.MAIL QueryParams.RECORD By default the value is set to QueryParams.DOCUMENT. For searching documents and folders use value: `(QueryParams.DOCUMENT \| QueryParams.FOLDER)`	Restricts the search to a node types.
author	String	No.	Value must be a valid userId.	Filters by creator user.
name	String	Yes.		Filters by node name.
title	String	Yes.		Filters by title name.
keywords	Set<String>	Yes.		Filters by keywords.
categories	Set<String>	No.	Values should be a category UUID, not use path value.	Filters by categories.
content		Yes.		Filters by binary content.
mimeType		No.	Value should be a valid and registered MIME type. Only can be applied to documents node.	Filters by document MIME type.
language		No.	Value should be a valid language. Only can be applied to documents node.	Filters by document language.
folder		No.	When empty is used by default "/okm:root" node. Value should be a valid UUID, not use a path value.	Filters by a folder.
folderRecursive	Boolean	No.	Only has sense to set this variable to true when the variable folder is not empty.	Enables filter recursively by a folder.
lastModifiedFrom	Calendar	No.		Filters by nodes created after a date.
lastModifiedTo	Calendar	No.		Filters by nodes created before a date.
mailSubject	String	Yes.	Only apply to mail nodes.	Filters by mail subject field.
mailFrom	String	Yes.	Only apply to mail nodes.	Filters by mail from field.
mailTo		Yes.	Only apply to mail nodes.	Filters by mail to field.
notes		Yes.		Filters by notes.
properties	Map<String, String>	Yes on almost.	On metadata field values like "date" can not be applied wilcards. The map of the properties is composed of pairs: ('metadata_field_name','metada_field_value") For example: `Map<String, String> properties = new HashMap(); properties.put("okp:consulting.name", "name value");` Filtering by range of dates: `Calendar to = Calendar.getInstance(); // today to.set(0, Calendar.HOUR); to.set(0, Calendar.MINUTE); to.set(0, Calendar.SECOND); to.set(0, Calendar.MILLISECOND); Calendar from = (Calendar) to.clone(); from.add(-3, Calendar.DATE); // three days before Map<String,String> properties = new HashMap<>(); properties.put("okp:consulting.date", ISO8601.formatBasic(from)+","+ISO8601.formatBasic(to));` When filtering by range of dates you must set both values ( from and to ), otherwise the filter will be ignored from the OpenKM side. To filtering by a metadata field of type multiple like this: `<select label="Multiple" name="okp:consulting.multiple" type="multiple"> <option label="One" value="one"/> <option label="Two" value="two"/> <option label="Three" value="three" /> </select>` You should do: `properties.put("okp:consulting.multiple", "one;two");` Where "one" and "two" are valid values and character ";" is used as separator.	Filters by metadata group values.
The search operation is done only by AND logic.

Wildcard examples:

Variable	Example	Description
name	*test.html**	Any document that starts with characters "test" and ends with characters ".html"
name	test?.html	Any document that starts with characters "test" followed by a single character and ends with characters ".html"
name	?test*	Any of the documents where the first character doesn't matter, but is followed by the characters, "test".

Methods

find

Description:

Method	Return values	Description
find(QueryParams queryParams, String propertiesPlugin)	List<QueryResult>	Returns a list of results filtered by the values of the queryParams parameter.
The parameter "propertiesPlugin" must be a canonical class name of the class which implements the NodeProperties interface. Retrieving entire Objects ( Document, Folder, Record, Mail ) from REST can take a lot of time - marshalling and unmarshalling process - while you are only interesting on using only few Objects variables. If its your case you can use NodeProperties classes for retrieving the Object variables what you really need.

Method

Return values

Description

find(QueryParams queryParams, String propertiesPlugin)

List<QueryResult>

Returns a list of results filtered by the values of the queryParams parameter.

The parameter "propertiesPlugin" must be a canonical class name of the class which implements the NodeProperties interface.

Retrieving entire Objects ( Document, Folder, Record, Mail ) from REST can take a lot of time - marshalling and unmarshalling process - while you are only interesting on using only few Objects variables. If its your case you can use NodeProperties classes for retrieving the Object variables what you really need.

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.QueryParams;
import com.openkm.sdk4j.bean.QueryResult;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            QueryParams qParams = new QueryParams();
            qParams.setDomain(QueryParams.DOCUMENT + QueryParams.FOLDER);
            qParams.setName("test*");

            for (QueryResult qr : ws.find(qParams, null)) {
                System.out.println(qr);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findPaginated

Description:

Method	Return values	Description
findPaginated(QueryParams queryParams, int offset, int limit, String propertiesPlugin)	ResultSet	Returns a list of paginated results filtered by the values of the queryParams parameter.
The parameter "limit" and "offset" allows you to retrieve just a portion of the results of a query. The parameter "limit" is used to limit the number of results returned. The parameter "offset" says to skip that many results before the beginning to return results. The parameter "propertiesPlugin" must be the canonical class name of the class which implements the NodeProperties interface. For example if your query has 1000 results, but you only want to return the first 10, you should use these values: limit=10 offset=0 Now suppose you want to show the results from 11-20, you should use these values: limit=10 offset=10 Retrieving entire Objects ( Document, Folder, Record, Mail ) from REST can take a lot of time - marshalling and unmarshalling process - while you are only interesting on using only few Objects variables. If its your case you can use NodeProperties classes for retrieving the Object variables what you really need.

Method

Return values

Description

findPaginated(QueryParams queryParams, int offset, int limit, String propertiesPlugin)

ResultSet

Returns a list of paginated results filtered by the values of the queryParams parameter.

The parameter "limit" and "offset" allows you to retrieve just a portion of the results of a query.

The parameter "limit" is used to limit the number of results returned.
The parameter "offset" says to skip that many results before the beginning to return results.
The parameter "propertiesPlugin" must be the canonical class name of the class which implements the NodeProperties interface.

For example if your query has 1000 results, but you only want to return the first 10, you should use these values:

limit=10
offset=0

Now suppose you want to show the results from 11-20, you should use these values:

limit=10
offset=10

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.QueryParams;
import com.openkm.sdk4j.bean.QueryResult;
import com.openkm.sdk4j.bean.ResultSet;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            QueryParams qParams = new QueryParams();
            qParams.setDomain(QueryParams.DOCUMENT + QueryParams.FOLDER);
            qParams.setName("test*");
            ResultSet rs = ws.findPaginated(qParams, 20, 10, null);
            System.out.println("Total results: " + rs.getTotal());

            for (QueryResult qr : rs.getResults()) {
                System.out.println(qr);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getKeywordMap

Description:

Method	Return values	Description
getKeywordMap(List<String> filter)	Map<String, Integer>	Returns a map of keywords with its count value filtered by other keywords.
Example: Doc1.txt has keywords "test", "one", "two". Doc2.txt has keywords "test", "one" Doc3.txt has keywords "test", "three". The results filtering by "test" -> "one", "two", "three". The results filtering by "one" -> "test", "two". The results filtering by "two" -> "test", "one". The results filtering by "three" -> "test". The results filtering by "one" and "two" -> "test".

Example:

package com.openkm;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            // All keywords without filtering
            System.out.println("Without filtering");
            Map<String, Integer> keywords = ws.getKeywordMap(new ArrayList<String>());

            for (String key : keywords.keySet()) {
                System.out.println(key + " is used :" + keywords.get(key));
            }

            // Keywords filtered
            System.out.println("Filtering");
            keywords = ws.getKeywordMap(Arrays.asList("test"));

            for (String key : keywords.keySet()) {
                System.out.println(key + " is used :" + keywords.get(key));
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getCategorizedDocuments

Description:

Method	Return values	Description
getCategorizedDocuments(String categoryId)	List<Document>	Retrieves a list of all documents related with a category.
The values of the categoryId parameter should be a category folder UUID.

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.Document;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            for (Document doc : ws.getCategorizedDocuments("58c9b25f-d83e-4006-bd78-e26d7c6fb648")) {
                System.out.println(doc);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findByQueryPaginated

Description:

Method	Return values	Description
findByQueryPaginated(String query, int offset, int limit, String propertiesPlugin)	ResultSet	Returns a list of paginated results filtered by the values of the query parameter.
The syntax to use in the statement parameter is the pair 'field:value'. For example: "name:grial" is filtering field name by word grial. More information about lucene sintaxis at Lucene query syntax. The parameter "limit" and "offset" allows you to retrieve just a portion of the results of a query. The parameter "limit" is used to limit the number of results returned. The parameter "offset" says to skip that many results before the beginning to return results. The parameter "propertiesPlugin" must be the canonical class name of the class which implements the NodeProperties interface. For example if your query has 1000 results, but you only want to return the first 10, you should use these values: limit=10 offset=0 Now suppose you want to show the results from 11-20, you should use these values: limit=10 offset=10

Method

Return values

Description

findByQueryPaginated(String query, int offset, int limit, String propertiesPlugin)

ResultSet

Returns a list of paginated results filtered by the values of the query parameter.

The syntax to use in the statement parameter is the pair 'field:value'. For example:

"name:grial" is filtering field name by word grial.

More information about lucene sintaxis at Lucene query syntax.

The parameter "limit" and "offset" allows you to retrieve just a portion of the results of a query.

The parameter "limit" is used to limit the number of results returned.
The parameter "offset" says to skip that many results before the beginning to return results.
The parameter "propertiesPlugin" must be the canonical class name of the class which implements the NodeProperties interface.

For example if your query has 1000 results, but you only want to return the first 10, you should use these values:

limit=10
offset=0

Now suppose you want to show the results from 11-20, you should use these values:

limit=10
offset=10

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.QueryResult;
import com.openkm.sdk4j.bean.ResultSet;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            ResultSet rs = ws.findByQueryPaginated("text:grial AND name:t*.pdf", 0, 10, null);
            System.out.println("Total results:" + rs.getTotal());

            for (QueryResult qr : rs.getResults()) {
                System.out.println(qr);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

saveSearch

Description:

Method	Return values	Description
saveSearch(QueryParams params)	Long	Saves a search parameters.
The variable queryName of the parameter params, should have to be initialized.

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.QueryParams;
import com.openkm.sdk4j.bean.QueryResult;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            QueryParams qParams = new QueryParams();
            qParams.setDomain(QueryParams.DOCUMENT + QueryParams.FOLDER);
            qParams.setName("test*");
            for (QueryResult qr : ws.find(qParams, null)) {
                System.out.println(qr);
            }
            // Save the search to be used later
            qParams.setQueryName("sample search");
            ws.saveSearch(qParams);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

updateSearch

Description:

Method	Return values	Description
updateSearch(QueryParams params)	void	Updates a previously saved search parameters.
Only can be updated as a saved search created by the same user user who's executing the method.

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.QueryParams;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            for (QueryParams qParams : ws.getAllSearchs()) {
                if (qParams.getQueryName().equals("sample search")) {
                    // Change some value.
                    qParams.setName("admin*.html");
                    ws.updateSearch(qParams);
                }
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getSearch

Description:

Method	Return values	Description
getSearch(int qpId)	QueryParams	Gets saved search parameters.
Only can be retrieved as a saved search created by the same user who's executing the method.

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.QueryParams;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            int qpId = 1; // Some valid search id
            QueryParams qParams = ws.getSearch(qpId);
            System.out.println(qParams);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getAllSearchs

Description:

Method	Return values	Description
getAllSearchs()	List<QueryParams>	Retrieves a list of all saved search parameters.
Only will be retrieved the list of the saved searches created by the same user who's executing the method.

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.QueryParams;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            for (QueryParams qParams : ws.getAllSearchs()) {
                System.out.println(qParams);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

deleteSearch

Description:

Method	Return values	Description
deleteSearch(int qpId)	void	Deletes a saved search parameters.
Only can be deleted as a saved search created by the same user user who's executing the method.

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            int qpId = 1; // Some valid search id
            ws.deleteSearch(qpId);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findAllDefaultByNodeClass

Description:

Method	Return values	Description
findAllDefaultByNodeClass(long ncId)	List<QueryParams>	Retrieve a list of saved searches of a NodeClass

Example:

package com.openkm;

import java.util.List;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.QueryParams;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            long ncId = 1;
            List<QueryParams> results = ws.findAllDefaultByNodeClass(ncId);
            for (QueryParams params : results) {
                System.out.println(params);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findByQuery

Description:

Method	Return values	Description
findByQuery(String query, String propertiesPlugin)	List<QueryResult>	Returns a list of results filtered by the query parameter.
The syntax to use in the statement parameter is the pair 'field:value'. For example: "name:grial" is filtering field name by word grial. More information about lucene sintaxis at Lucene query syntax. The parameter "propertiesPlugin" must be the canonical class name of the class which implements the NodeProperties interface.

Example:

package com.openkm;

import java.util.List;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.QueryResult;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            List<QueryResult> results = ws.findByQuery("keyword:test AND name:t*.pdf", null);            

            for (QueryResult qr : results) {
                System.out.println(qr);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findWithMetadata

Description:

Method	Return values	Description
findWithMetadata(QueryParams queryParams, String propertiesPlugin, List<String> groups)	List<QueryResult>	Returns a list of results with metadata values filtered by the queryParams parameter.
The parameter "propertiesPlugin" must be a canonical class name of the class which implements the NodeProperties interface. The parameter "groups" must be valid metadata group names. Retrieving entire Objects ( Document, Folder, Record, Mail ) from REST can take a lot of time - marshalling and unmarshalling process - while you are only interesting on using only few Objects variables. If its your case you can use NodeProperties classes for retrieving the Object variables what you really need.

Example:

package com.openkm;

import java.util.ArrayList;
import java.util.List;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.QueryParams;
import com.openkm.sdk4j.bean.QueryResult;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            QueryParams qParams = new QueryParams();
            qParams.setDomain(QueryParams.DOCUMENT + QueryParams.FOLDER);
            qParams.setName("test*");

            List<String> groups = new ArrayList<>();
            groups.add("okg:consulting");

            for (QueryResult qr : ws.findWithMetadata(qParams, null, groups)) {
                System.out.println(qr);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findWithMedataPaginated

Description:

Method	Return values	Description
findWithMetadataPaginated(QueryParams queryParams, int offset, int limit, String propertiesPlugin, List<String> groups)	ResultSet	Returns a list of paginated results with metadata values filtered by the queryParams parameter.
The parameter "limit" and "offset" allows you to retrieve just a portion of the results of a query. The parameter "limit" is used to limit the number of results returned. The parameter "offset" says to skip that many results before the beginning to return results. The parameter "propertiesPlugin" must be the canonical class name of the class which implements the NodeProperties interface. The parameter "groups" must be valid metadata group names. For example if your query has 1000 results, but you only want to return the first 10, you should use these values: limit=10 offset=0 Now suppose you want to show the results from 11-20, you should use these values: limit=10 offset=10 Retrieving entire Objects ( Document, Folder, Record, Mail ) from REST can take a lot of time - marshalling and unmarshalling process - while you are only interesting on using only few Objects variables. If its your case you can use NodeProperties classes for retrieving the Object variables what you really need.

Example:

package com.openkm;

import java.util.ArrayList;
import java.util.List;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.QueryParams;
import com.openkm.sdk4j.bean.QueryResult;
import com.openkm.sdk4j.bean.ResultSet;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            QueryParams qParams = new QueryParams();
            qParams.setDomain(QueryParams.DOCUMENT + QueryParams.FOLDER);
            qParams.setName("test*");

            List<String> groups = new ArrayList<>();
            groups.add("okg:consulting");

            ResultSet rs = ws.findWithMetadataPaginated(qParams, 0, 10, null, groups);
            System.out.println("Total results: " + rs.getTotal());

            for (QueryResult qr : rs.getResults()) {
                System.out.println(qr);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

Table of contents [ Hide Show ]

Basics
Methods

find
findPaginated
getKeywordMap
getCategorizedDocuments
findByQueryPaginated
saveSearch
updateSearch
getSearch
getAllSearchs
deleteSearch
findAllDefaultByNodeClass
findByQuery
findWithMetadata
findWithMedataPaginated

SDK for Java 3.4

Search samples

Basics

Methods

find

findPaginated

getKeywordMap

getCategorizedDocuments

findByQueryPaginated

saveSearch

updateSearch

getSearch

getAllSearchs

deleteSearch

findAllDefaultByNodeClass

findByQuery

findWithMetadata

findWithMedataPaginated