Search samples

Aspectos básicos

La mayoría de los métodos usan QueryParams; aquí tiene algunos consejos sobre cómo usarlos.

Variables	Tipo	Permite comodines	Restricciones	Descripción
domain	long	No.	Valores disponibles: - QueryParams.DOCUMENT - QueryParams.FOLDER - QueryParams.MAIL 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 el nombre del nodo.
keywords	Set	Sí.		Filtra por palabras clave.
categories	Set	No.	Los valores deben ser UUID de categoría; no utilice una 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.
path		No.	Si está vacío, se usa por defecto el nodo “/okm:root”.	Filtra por una carpeta.
lastModifiedFrom	Calendar	No.		Filtra por nodos creados después de una fecha.
lastModifiedTo	Calendar	No.		Filtra por nodos creados antes de una fecha.
mailSubject	String	Sí.	Solo se aplica a nodos de tipo correo.	Filtra por el campo asunto del correo.
mailFrom	String	Sí.	Solo se aplica a nodos de tipo correo.	Filtra por el campo From del correo.
mailTo		Sí.	Solo se aplica a nodos de tipo correo.	Filtra por el campo To del correo.
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.

Precaución

La operación de búsqueda se realiza utilizando únicamente lógica AND.

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”.

Métodos

findByContent

Descripción:

Método	Valores de retorno	Descripción
findByContent(String content)	List	Devuelve una lista de resultados filtrados por el valor del parámetro content.

Precaución

Este método solo busca entre los documentos; no tiene en cuenta ningún otro tipo de nodo.

Ejemplo:

package com.openkm;

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:8180/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
        try {
            for (QueryResult qr : ws.findByContent("test")) {
                System.out.println(qr);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findByName

Descripción:

Método	Valores de retorno	Descripción
findByName(String name)	List	Devuelve una lista de resultados filtrados por el valor del parámetro name.

Precaución

Este método solo busca entre los documentos; no tiene en cuenta ningún otro tipo de nodo.

Ejemplo:

package com.openkm;

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:8180/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
        try {
            for (QueryResult qr : ws.findByName("test*.html")) {
                System.out.println(qr);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findByKeywords

Descripción:

Método	Valores de retorno	Descripción
findByKeywords(List keywords)	List	Devuelve una lista de resultados filtrados por los valores del parámetro keywords.

Precaución

Este método solo busca entre los documentos; no tiene en cuenta ningún otro tipo de nodo.

Ejemplo:

package com.openkm;

import java.util.Arrays;

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 username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
        try {
            for (QueryResult qr : ws.findByKeywords(Arrays.asList("test"))) {
                System.out.println(qr);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

find

Descripción:

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

Ejemplo:

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 username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
        try {
            QueryParams qParams = new QueryParams();
            qParams.setDomain(QueryParams.DOCUMENT);
            qParams.setName("test*.html");
                        for (QueryResult qr : ws.find(qParams)) {
                System.out.println(qr);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findPaginated

Descripción:

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

Consejo

Los parámetros “limit” y “offset” permiten obtener solo una parte de los resultados de una consulta.

• El parámetro “limit” se usa para limitar el número de resultados devueltos.
• El parámetro “offset” especifica cuántos resultados omitir antes de devolver resultados.

Nota

Por ejemplo, si su consulta tiene 1000 resultados pero solo quiere devolver los primeros 10, debe usar estos valores:

• limit=10
• offset=0

Ahora suponga que quiere mostrar los resultados del 11 al 20; debe usar estos valores:

• limit=10
• offset=10

Ejemplo:

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 username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
        try {
            QueryParams qParams = new QueryParams();
            qParams.setDomain(QueryParams.DOCUMENT);
            qParams.setName("test*.html");
            ResultSet rs = ws.findPaginated(qParams, 20, 10);
            System.out.println("Total results:"+rs.getTotal());
                        for (QueryResult qr : rs.getResults()) {
                System.out.println(qr);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findSimpleQueryPaginated

Descripción:

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

Nota

La sintaxis a utilizar en el parámetro statement es el par ‘campo:valor’. Por ejemplo:

• “name:grial” filtra el campo name por la palabra grial.

Más información sobre la sintaxis de Lucene en Lucene query syntax.

Consejo

Los parámetros “limit” y “offset” permiten obtener solo una parte de los resultados de una consulta.

• El parámetro “limit” se usa para limitar el número de resultados devueltos.
• El parámetro “offset” especifica cuántos resultados omitir antes de devolver resultados.

Nota

Por ejemplo, si su consulta tiene 1000 resultados pero solo quiere devolver los primeros 10, debe usar estos valores:

• limit=10
• offset=0

Ahora, suponga que quiere mostrar los resultados del 11 al 20; debe usar estos valores:

• limit=10
• offset=10

Ejemplo:

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 username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
        try {
            ResultSet rs = ws.findSimpleQueryPaginated("name:grial", 20, 10);
            System.out.println("Total results:"+rs.getTotal());
                        for (QueryResult qr : rs.getResults()) {
                System.out.println(qr);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findMoreLikeThis

Descripción:

Método	Valores de retorno	Descripción
findMoreLikeThis(String uuid, int max)	ResultSet	Devuelve una lista de documentos que el motor de búsqueda considera similares.

Precaución

Este método solo puede usarse con documentos.

• El uuid es el UUID de un documento.
• El valor max se usa para limitar el número de resultados devueltos.

Ejemplo:

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 username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
        try {
            ResultSet rs = ws.findMoreLikeThis("f123a950-0329-4d62-8328-0ff500fd42db", 100);
            System.out.println("Total results:"+rs.getTotal());
                        for (QueryResult qr : rs.getResults()) {
                System.out.println(qr);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

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.

Nota

Ejemplo:

• Doc1.txt tiene las palabras clave “test”, “one”, “two”.
• Doc2.txt tiene las palabras clave “test”, “one”
• Doc3.txt tiene las palabras clave “test”, “three”.

El resultado al filtrar por “test” -> “one”, “two”, “three”.

El resultado al filtrar por “one” -> “test”, “two”.

El resultado al filtrar por “two” -> “test”, “one”.

El resultado al filtrar por “three” -> “test”.

El resultado al filtrar por “one” y “two” -> “test”.

Ejemplo:

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:8180/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
        try {
            // 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

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.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:8180/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
        try {
            for (Document doc : ws.getCategorizedDocuments("/okm:categories/invoices")) {
                System.out.println(doc);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findByQuery

Descripción:

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

Nota

La sintaxis que debe usar en el parámetro de la sentencia es el par ‘campo:valor’. Por ejemplo:

• “name:grial” filtra el campo name por la palabra grial.

Más información sobre la sintaxis de Lucene en Lucene query syntax.

Ejemplo:

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 {
            List<QueryResult> results = ws.findByQuery("keyword:test AND name:t*.pdf");

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

findByQueryPaginated

Descripción:

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

Nota

La sintaxis que debe usar en el parámetro de la sentencia es el par ‘campo:valor’. Por ejemplo:

• “name:grial” filtra el campo name por la palabra grial.

Más información sobre la sintaxis de Lucene en Lucene query syntax.

Consejo

Los parámetros “limit” y “offset” permiten recuperar solo una parte de los resultados de una consulta.

• El parámetro “limit” se usa para limitar el número de resultados devueltos.
• El parámetro “offset” especifica cuántos resultados omitir antes de devolver resultados.

Nota

Por ejemplo, si su consulta tiene 1000 resultados pero solo quiere devolver los primeros 10, debe usar estos valores:

• limit=10
• offset=0

Ahora, suponga que quiere mostrar los resultados del 11 al 20; debe usar estos valores:

• limit=10
• offset=10

Ejemplo:

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 {
            ResultSet rs = ws.findByQueryPaginated("text:grial AND name:t*.pdf", 0, 10);
            System.out.println("Total results:" + rs.getTotal());

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