Ir al contenido
Otras versiones

Cargando…

Search samples

Aspectos básicos

Sección titulada «Aspectos básicos»

Casi todos los métodos utilizan QueryParams. Aquí tiene algunos consejos sobre cómo utilizarlo.

Variables Tipo Permite comodines Restricciones Descripción
domain long No. Valores disponibles:
- QueryParams.DOCUMENT
- QueryParams.FOLDER
- QueryParams.MAIL
- QueryParams.RECORD
Por defecto, el valor es QueryParams.DOCUMENT.
Para buscar documentos y carpetas, use el valor:
<br>(QueryParams.DOCUMENT | QueryParams.FOLDER) <br>		 Restringe la búsqueda a tipos de nodo.
author String No. El valor debe ser un userId válido. Filtra por el usuario creador.
name String Sí. Filtra por nombre de nodo.
title String Sí. Filtra por título.
keywords Set Sí. Filtra por palabras clave.
categories Set No. Los valores deben ser un UUID de categoría; no utilice un valor de ruta. Filtra por categorías.
content Sí. Filtra por contenido binario.
mimeType No. El valor debe ser un tipo MIME válido y registrado.
Solo puede aplicarse a nodos de tipo documento.		 Filtra por el tipo MIME del documento.
language No. El valor debe ser un idioma válido.
Solo puede aplicarse a nodos de tipo documento.		 Filtra por el idioma del documento.
folder No. Si está vacío, se usa por defecto el nodo “/okm:root”.
El valor debe ser un UUID válido; no utilice una ruta.		 Filtra por una carpeta.
folderRecursive Boolean No. Solo tiene sentido establecer esta variable como true cuando la variable folder no está vacía. Habilita el filtrado recursivo por una carpeta.
lastModifiedFrom Calendar No. Filtra por nodos modificados después de una fecha.
lastModifiedTo Calendar No. Filtra por nodos modificados antes de una fecha.
mailSubject String Sí. Solo se aplica a nodos de correo. Filtra por el campo de asunto del correo.
mailFrom String Sí. Solo se aplica a nodos de correo. Filtra por el campo remitente del correo.
mailTo Sí. Solo se aplica a nodos de correo. Filtra por el campo destinatario del correo.
notes Sí. Filtra por notas.
properties Map<String, String> Sí, en casi todos. Los comodines no pueden aplicarse a valores de campos de metadatos como “date”.
El mapa de propiedades se compone de pares:
(‘nombre_campo_metadatos’,‘valor_campo_metadatos’)
Por ejemplo:
<br>Map<String, String> properties = new HashMap();<br>properties.put("okp:consulting.name", "name value");<br>
Filtrando por un rango de fechas:
<br>Calendar to = Calendar.getInstance(); // today<br>to.set(0, Calendar.HOUR);<br>to.set(0, Calendar.MINUTE);<br>to.set(0, Calendar.SECOND);<br>to.set(0, Calendar.MILLISECOND);<br>Calendar from = (Calendar) to.clone();<br>from.add(-3, Calendar.DATE); // three days before<br>Map<String,String> properties = new HashMap<>();<br>properties.put("okp:consulting.date", ISO8601.formatBasic(from)+","+ISO8601.formatBasic(to));<br>
Al filtrar por un rango de fechas, debe establecer ambos valores (from y to); de lo contrario, OpenKM ignorará el filtro.
Para filtrar por un campo de metadatos de tipo múltiple como este:
cs<br><select label="Multiple" name="okp:consulting.multiple" type="multiple"><br> <option label="One" value="one"/><br> <option label="Two" value="two"/><br> <option label="Three" value="three" /><br></select><br>
Debe hacer:
bash<br>properties.put("okp:consulting.multiple", "one;two");<br>
Donde “one” y “two” son valores válidos y el carácter “;” se usa como separador.		 Filtra por valores de un grupo de metadatos.

Ejemplos de comodines:

Variable Ejemplo Descripción
name test*.html Cualquier documento que empiece por los caracteres “test” y termine por los caracteres “.html”.
name test?.html Cualquier documento que empiece por los caracteres “test” seguidos de un único carácter y termine por los caracteres “.html”.
name ?test* Cualquier documento en el que el primer carácter no importa, pero va seguido de los caracteres “test”.

Ejemplo de código sugerido

Sección titulada «Ejemplo de código sugerido»

Primero debe crear el objeto webservice:

OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

A continuación, debe iniciar sesión mediante el método “login”. Puede acceder al método “login” desde el objeto webservice “ws”, tal y como se muestra a continuación:

ws.login(user, password);

Llegados a este punto puede utilizar todos los métodos de Search desde la clase “search” como se muestra a continuación:

ws.search.find(qParams, null)

Métodos

Sección titulada «Métodos»

find

Sección titulada «find»

Descripción:

Método Valores de retorno Descripción
find(QueryParams queryParams, String propertiesPlugin) List Devuelve una lista de resultados filtrados por los valores del parámetro queryParams.

Ejemplo:

package com.openkm;


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


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 params = new QueryParams();
            params.setDomain(QueryParams.DOCUMENT + QueryParams.FOLDER);
            params.setName("test*");


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

find

Sección titulada «find»

Descripción:

Método Valores de retorno Descripción
find(QueryParams queryParams, String sortField, boolean sortReverse, String propertiesPlugin) List Devuelve una lista de resultados filtrados por los valores del parámetro queryParams.

Ejemplo:

package com.openkm;


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


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 params = new QueryParams();
            params.setDomain(QueryParams.DOCUMENT + QueryParams.FOLDER);
            params.setName("test*");


            for (QueryResult qr : ws.search.find(params, SearchSortField.LAST_MODIFIED, true, null)) {
                System.out.println(qr);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findPaginated

Sección titulada «findPaginated»

Descripción:

Método Valores de retorno Descripción
findPaginated(QueryParams queryParams, int offset, int limit, String propertiesPlugin) ResultSet Devuelve una lista de resultados paginados filtrados por los valores del parámetro queryParams.

Ejemplo:

package com.openkm;


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


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 params = new QueryParams();
            params.setDomain(QueryParams.DOCUMENT + QueryParams.FOLDER);
            params.setName("test*");
            ResultSet rs = ws.search.findPaginated(params, 20, 10, null);
            System.out.println("Total results: " + rs.getTotal());


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

findPaginated

Sección titulada «findPaginated»

Descripción:

Método Valores de retorno Descripción
findPaginated(QueryParams queryParams, String sortField, boolean sortReverse, int offset, int limit, String propertiesPlugin) ResultSet Devuelve una lista de resultados paginados filtrados por los valores del parámetro queryParams.

Ejemplo:

package com.openkm;


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


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 params = new QueryParams();
            params.setDomain(QueryParams.DOCUMENT + QueryParams.FOLDER);
            params.setName("test*");


            ResultSet rs = ws.search.findPaginated(params, SearchSortField.LAST_MODIFIED, true, 20, 10, null);
            System.out.println("Total results: " + rs.getTotal());
            for (QueryResult qr : rs.getResults()) {
                System.out.println(qr);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findSimpleNodeBasePaginated

Sección titulada «findSimpleNodeBasePaginated»

Descripción:

Método Valores de retorno Descripción
findSimpleNodeBasePaginated(QueryParams queryParams, int offset, int limit) SimpleNodeBaseResultSet Devuelve una lista de resultados paginados de tipo SimpleNodeBase filtrados por los valores del parámetro queryParams.

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.*;
import com.openkm.sdk4j.impl.OKMWebservices;


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 params = new QueryParams();
            params.setDomain(QueryParams.DOCUMENT + QueryParams.FOLDER);
            params.setName("test*");
            SimpleNodeBaseResultSet rs = ws.search.findSimpleNodeBasePaginated(params, 20, 10);
            System.out.println("Total results: " + rs.getTotal());


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

findSimpleNodeBasePaginated

Sección titulada «findSimpleNodeBasePaginated»

Descripción:

Método Valores de retorno Descripción
findSimpleNodeBasePaginated(QueryParams queryParams, String sortField, boolean sortReverse, int offset, int limit) SimpleNodeBaseResultSet Devuelve una lista de resultados paginados de tipo SimpleNodeBase filtrados por los valores del parámetro queryParams.

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.*;
import com.openkm.sdk4j.impl.OKMWebservices;


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 params = new QueryParams();
            params.setDomain(QueryParams.DOCUMENT + QueryParams.FOLDER);
            params.setName("test*");


            SimpleNodeBaseResultSet result = ws.search.findSimpleNodeBasePaginated(params, SearchSortField.AUTHOR, true, 0, 10);
            System.out.println("Total: " + result.getTotal());
            for (SimpleNodeBase nodeBase : result.getResults()) {
                if (nodeBase != null) {
                    System.out.println(nodeBase.toString());
                }
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getKeywordMap

Sección titulada «getKeywordMap»

Descripción:

Método Valores de retorno Descripción
getKeywordMap(List filter) Map<String, Integer> Devuelve un mapa de palabras clave con su contador, filtrado por otras palabras clave.

Ejemplo:

package com.openkm;


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


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


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.search.getKeywordMap(Arrays.asList("test"));


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

getCategorizedDocuments

Sección titulada «getCategorizedDocuments»

Descripción:

Método Valores de retorno Descripción
getCategorizedDocuments(String categoryId) List Recupera una lista de todos los documentos relacionados con una categoría.

Ejemplo:

package com.openkm;


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


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.search.getCategorizedDocuments("58c9b25f-d83e-4006-bd78-e26d7c6fb648")) {
                System.out.println(doc);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

saveSearch

Sección titulada «saveSearch»

Descripción:

Método Valores de retorno Descripción
saveSearch(QueryParams params) Long Guarda parámetros de búsqueda.

Ejemplo:

package com.openkm;


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


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.search.saveSearch(qParams);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

updateSearch

Sección titulada «updateSearch»

Descripción:

Método Valores de retorno Descripción
updateSearch(QueryParams params) void Actualiza unos parámetros de búsqueda guardados previamente.

Ejemplo:

package com.openkm;


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


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.search.updateSearch(qParams);
                }
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getSearch

Sección titulada «getSearch»

Descripción:

Método Valores de retorno Descripción
getSearch(int qpId) QueryParams Obtiene los parámetros de una búsqueda guardada.

Ejemplo:

package com.openkm;


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


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.search.getSearch(qpId);
            System.out.println(qParams);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getAllSearchs

Sección titulada «getAllSearchs»

Descripción:

Método Valores de retorno Descripción
getAllSearchs() List Recupera una lista de todos los parámetros de búsqueda guardados.

Ejemplo:

package com.openkm;


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


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.search.getAllSearchs()) {
                System.out.println(qParams);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

deleteSearch

Sección titulada «deleteSearch»

Descripción:

Método Valores de retorno Descripción
deleteSearch(int qpId) void Elimina unos parámetros de búsqueda guardados.

Ejemplo:

package com.openkm;


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


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.search.deleteSearch(qpId);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findByQuery

Sección titulada «findByQuery»

Descripción:

Método Valores de retorno Descripción
findByQuery(String query, String propertiesPlugin) List Devuelve una lista de resultados filtrados por el parámetro query.

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.*;
import com.openkm.sdk4j.impl.OKMWebservices;


import java.util.List;


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.search.findByQuery("keyword:test AND name:t*.pdf", null);
            for (QueryResult qr : results) {
                System.out.println(qr);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findByQuery

Sección titulada «findByQuery»

Descripción:

Método Valores de retorno Descripción
findByQuery(String query, String sortField, boolean sortReverse, String propertiesPlugin) List Devuelve una lista de resultados filtrados por el parámetro query.

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.*;
import com.openkm.sdk4j.impl.OKMWebservices;


import java.util.List;


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.search.findByQuery("keyword:test AND name:t*.pdf", SearchSortField.NAME, true, null);
            for (QueryResult qr : results) {
                System.out.println(qr);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findByQueryPaginated

Sección titulada «findByQueryPaginated»

Descripción:

Método Valores de retorno Descripción
findByQueryPaginated(String query, int offset, int limit, String propertiesPlugin) ResultSet Devuelve una lista de resultados paginados filtrados por los valores del parámetro query.

Ejemplo:

package com.openkm;


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


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.search.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();
        }
    }
}

findByQueryPaginated

Sección titulada «findByQueryPaginated»

Descripción:

Método Valores de retorno Descripción
findByQueryPaginated(String query, String sortField, boolean sortReverse, int offset, int limit, String propertiesPlugin) ResultSet Devuelve una lista de resultados paginados filtrados por los valores del parámetro query.

Ejemplo:

package com.openkm;


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


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.search.findByQueryPaginated("text:grial AND name:t*.pdf", SearchSortField.NAME, true, 0, 10, null);
            System.out.println("Total results:" + rs.getTotal());
            for (QueryResult qr : rs.getResults()) {
                System.out.println(qr);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findSimpleNodeBaseByQueryPaginated

Sección titulada «findSimpleNodeBaseByQueryPaginated»

Descripción:

Método Valores de retorno Descripción
findSimpleNodeBaseByQueryPaginated(String query, int offset, int limit) SimpleNodeBaseResultSet Devuelve una lista de resultados paginados filtrados por los valores del parámetro query.

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.SimpleNodeBase;
import com.openkm.sdk4j.bean.SimpleNodeBaseResultSet;
import com.openkm.sdk4j.impl.OKMWebservices;


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);
            SimpleNodeBaseResultSet result = ws.search.findSimpleNodeBaseByQueryPaginated("text:grial AND name:t*.pdF", 0, 10);
            for (SimpleNodeBase nodeBase : result.getResults()) {
                if (nodeBase != null) {
                    System.out.println(nodeBase.toString());
                }
            }
            System.out.println("Total: " + result.getTotal());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findSimpleNodeBaseByQueryPaginated

Sección titulada «findSimpleNodeBaseByQueryPaginated»

Descripción:

Método Valores de retorno Descripción
findSimpleNodeBaseByQueryPaginated(String query, String sortField, boolean sortReverse, int offset, int limit) SimpleNodeBaseResultSet Devuelve una lista de resultados paginados filtrados por los valores del parámetro query.

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.*;
import com.openkm.sdk4j.impl.OKMWebservices;


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);
            SimpleNodeBaseResultSet result = ws.search.findSimpleNodeBaseByQueryPaginated("text:grial AND name:t*.pdF", SearchSortField.NAME, true, 0, 10);
            System.out.println("Total: " + result.getTotal());
            for (SimpleNodeBase nodeBase : result.getResults()) {
                if (nodeBase != null) {
                    System.out.println(nodeBase.toString());
                }
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findWithMetadata

Sección titulada «findWithMetadata»

Descripción:

Método Valores de retorno Descripción
findWithMetadata(QueryParams queryParams, String propertiesPlugin, List groups) List Devuelve una lista de resultados con valores de metadatos filtrados por el parámetro queryParams.

Ejemplo:

package com.openkm;


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


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


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.search.findWithMetadata(qParams, null, groups)) {
                System.out.println(qr);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findWithMetadata

Sección titulada «findWithMetadata»

Descripción:

Método Valores de retorno Descripción
findWithMetadata(QueryParams queryParams, String sortField, boolean sortReverse, String propertiesPlugin, List groups) List Devuelve una lista de resultados con valores de metadatos filtrados por el parámetro queryParams.

Ejemplo:

package com.openkm;


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


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


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 params = new QueryParams();
            params.setDomain(QueryParams.DOCUMENT + QueryParams.FOLDER);
            params.setName("test*");


            List<String> groups = new ArrayList<>();
            groups.add("okg:consulting");
            for (QueryResult qr : ws.search.findWithMetadata(params, SearchSortField.NAME, true, null, groups)) {
                System.out.println(qr);
            }


        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findWithMetadataPaginated

Sección titulada «findWithMetadataPaginated»

Descripción:

Método Valores de retorno Descripción
findWithMetadataPaginated(QueryParams queryParams, int offset, int limit, String propertiesPlugin, List groups) ResultSet Devuelve una lista de resultados paginados con valores de metadatos filtrados por el parámetro queryParams.

Ejemplo:

package com.openkm;


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


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


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.search.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();
        }
    }
}

findWithMetadataPaginated

Sección titulada «findWithMetadataPaginated»

Descripción:

Método Valores de retorno Descripción
findWithMetadataPaginated(QueryParams queryParams, int offset, int limit, String propertiesPlugin, List groups) ResultSet Devuelve una lista de resultados paginados con valores de metadatos filtrados por el parámetro queryParams.

Ejemplo:

package com.openkm;


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


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 params = new QueryParams();
            params.setDomain(QueryParams.DOCUMENT + QueryParams.FOLDER);
            params.setName("test*");


            ResultSet rs = ws.search.findWithMetadataPaginated(params, SearchSortField.AUTHOR, true, 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();
        }
    }
}

getMimeTypes

Sección titulada «getMimeTypes»

Descripción:

Método Valores de retorno Descripción
getMimeTypes() List Recupera una lista de tipos MIME.

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.MimeType;
import com.openkm.sdk4j.impl.OKMWebservices;


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 (MimeType mimeType : ws.search.getMimeTypes()) {
                System.out.println(mimeType);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

csvExport

Sección titulada «csvExport»

Descripción:

Método Valores de retorno Descripción
csvExport(String lang, QueryParams queryParams, boolean compact) InputStream Exporta una lista de resultados como fichero CSV filtrada por los valores del parámetro queryParams.
  • El parámetro lang debe cumplir con ISO 639-1.

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.QueryParams;
import com.openkm.sdk4j.impl.OKMWebservices;
import org.apache.commons.io.IOUtils;


import java.io.FileOutputStream;
import java.io.InputStream;
import java.io.OutputStream;


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 params = new QueryParams();
            params.setDomain(QueryParams.DOCUMENT + QueryParams.FOLDER);
            params.setName("test*");


            InputStream is = ws.search.csvExport("es-ES", params, false);
            OutputStream fos = new FileOutputStream("/home/openkm/okm/export.csv");
            IOUtils.copy(is, fos);
            IOUtils.closeQuietly(is);
            IOUtils.closeQuietly(fos);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}