PropertyGroup samples

Aspectos básicos

En la mayoría de los métodos verá un parámetro llamado “nodeId”. El valor de este parámetro puede ser un UUID o una ruta (path) válidos de documento, carpeta, correo o expediente.

La clase com.openkm.sdk4j.util.ISO8601 debe usarse para establecer y analizar los campos de metadatos de tipo fecha. Los valores de los campos de metadatos de tipo fecha se almacenan en la aplicación en formato básico ISO-8601.

Para convertir el campo de metadatos de tipo fecha recuperado en una fecha válida, use:

Calendar cal = ISO8601.parseBasic(metadataFieldValue);

Para guardar el valor de fecha en el campo de metadatos de tipo fecha, use:

Calendar cal = Calendar.getInstance(); // Present date
String metadataFieldValue = ISO8601.formatBasic(cal);
// metadataFieldValue can be saved into repository metadata field of type date

Métodos

addGroup

Descripción:

Método	Valores de retorno	Descripción
addGroup(String nodeId, String grpName)	void	Añade un grupo de metadatos vacío a un nodo.

El valor de grpName debe ser un nombre de grupo de metadatos válido.

Ejemplo:

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

        try {
    ws.addGroup("/okm:root/logo.pdf", "okg:consulting");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

removeGroup

Descripción:

Método	Valores de retorno	Descripción
removeGroup(String nodeId, String grpName)	void	Elimina un grupo de metadatos de un nodo.

El valor de grpName debe ser un nombre de grupo de metadatos válido.

Ejemplo:

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

        try {
    ws.removeGroup("/okm:root/logo.pdf", "okg:consulting");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getGroups

Descripción:

Método	Valores de retorno	Descripción
getGroups(String nodeId)	List	Recupera una lista de los grupos de metadatos asignados a un nodo.

Ejemplo:

package com.openkm;

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

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 (PropertyGroup pGroup : ws.getGroups("/okm:root/logo.pdf")) {
     System.out.println(pGroup);
    }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getAllGroups

Descripción:

Método	Valores de retorno	Descripción
getAllGroups()	List	Recupera una lista de todos los grupos de metadatos definidos en la aplicación.

Ejemplo:

package com.openkm;

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

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 (PropertyGroup pGroup : ws.getAllGroups()) {
     System.out.println(pGroup);
    }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getPropertyGroupProperties

Descripción:

Método	Valores de retorno	Descripción
getPropertyGroupProperties(String nodeId, String grpName)	List	Recupera una lista de todos los elementos del grupo de metadatos junto con los valores del nodo.

El valor de grpName debe ser un nombre de grupo de metadatos válido.

Ejemplo:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.form.FormElement;

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 (FormElement fElement : ws.getPropertyGroupProperties("/okm:root/logo.pdf", "okg:consulting")) {
     System.out.println(fElement);
    }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getPropertyGroupForm

Descripción:

Método	Valores de retorno	Descripción
getPropertyGroupForm(String grpName)	List	Recupera una lista con todas las definiciones de elementos del grupo de metadatos.

El valor de grpName debe ser un nombre de grupo de metadatos válido.

Ejemplo:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.form.FormElement;

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 (FormElement fElement : ws.getPropertyGroupForm("okg:consulting")) {
     System.out.println(fElement);
    }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

setPropertyGroupProperties

Descripción:

Método	Valores de retorno	Descripción
setPropertyGroupProperties(String nodeId, String grpName, List ofeList)	void	Cambia los valores del grupo de metadatos de un nodo.

El valor de grpName debe ser un nombre de grupo de metadatos válido.

El siguiente ejemplo se basa en esta definición de grupo de metadatos:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE property-groups PUBLIC "-//OpenKM//DTD Property Groups 2.0//EN"
                                 "http://www.openkm.com/dtd/property-groups-2.0.dtd">
<property-groups>
  <property-group label="Consulting" name="okg:consulting">
    <input label="Name" type="text" name="okp:consulting.name"/>
    <input label="Date" type="date" name="okp:consulting.date" />
    <checkbox label="Important" name="okp:consulting.important"/>
    <textarea label="Comment" name="okp:consulting.comment"/>
  </property-group>
</property-groups>

Ejemplo:

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.form.FormElement;
import com.openkm.sdk4j.bean.form.Input;

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 {
    // Modify with a full FormElement list
    List<FormElement> fElements = ws.getPropertyGroupProperties("/okm:root/logo.pdf","okg:consulting");
    for (FormElement fElement : fElements) {
     if (fElement.getName().equals("okp:consulting.name")) {
      Input name = (Input) fElement;
      name.setValue("new value");
     }
    }

    ws.setPropertyGroupProperties("/okm:root/logo.pdf", "okg:consulting", fElements);

    // Same modification with only affected FormElement
    fElements = new ArrayList<>();
    Input name = new Input();
    name.setName("okp:consulting.name");
    name.setValue("new value");
    fElements.add(name);
    ws.setPropertyGroupProperties("/okm:root/logo.pdf","okg:consulting", fElements);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

setPropertyGroupPropertiesSimple

Descripción:

Método	Valores de retorno	Descripción
setPropertyGroupPropertiesSimple(String nodeId, String grpName, Map<String, String> properties)	void	Cambia los valores del grupo de metadatos de un nodo.

El valor de grpName debe ser un nombre de grupo de metadatos válido.

El siguiente ejemplo se basa en esta definición de grupo de metadatos:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE property-groups PUBLIC "-//OpenKM//DTD Property Groups 2.0//EN"
                                 "http://www.openkm.com/dtd/property-groups-2.0.dtd">
<property-groups>
  <property-group label="Consulting" name="okg:consulting">
    <input label="Name" type="text" name="okp:consulting.name"/>
    <input label="Date" type="date" name="okp:consulting.date" />
    <checkbox label="Important" name="okp:consulting.important"/>
    <textarea label="Comment" name="okp:consulting.comment"/>
  </property-group>
</property-groups>

Para añadir varios valores a un campo de metadatos de tipo “multiple” como este:

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

Debe hacer:

properties.put("okp:consulting.multiple", "one;two");

Donde “one” y “two” son valores válidos y el carácter “;” se usa como separador.

Ejemplo:

package com.openkm;

import java.util.Calendar;
import java.util.HashMap;
import java.util.Map;

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

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 {
    Map<String, String> properties = new HashMap<>();
    properties.put("okp:consulting.name", "new name");

    // Date fields must be saved with basic ISO 8601 format
    properties.put("okp:consulting.date", ISO8601.formatBasic(Calendar.getInstance()));
    ws.setPropertyGroupPropertiesSimple("/okm:root/logo.pdf","okg:consulting", properties);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

hasGroup

Descripción:

Método	Valores de retorno	Descripción
hasGroup(String nodeId, String grpName)	Boolean	Devuelve un booleano que indica si el nodo tiene un grupo de metadatos.

Ejemplo:

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

        try {
    System.out.println("Have metadata group:" + ws.hasGroup("/okm:root/logo.pdf", "okg:consulting"));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getRegisteredDefinition

Descripción:

Método	Valores de retorno	Descripción
getRegisteredDefinition()	String	Devuelve la definición XML de los grupos de metadatos.

Ejemplo:

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

        try {
    System.out.println(ws.getRegisteredDefinition());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

registerDefinition

Descripción:

Método	Valores de retorno	Descripción
registerDefinition(InputStream is)	void	Establece la definición XML de los grupos de metadatos en el repositorio.

Ejemplo:

package com.openkm;

import java.io.FileInputStream;
import java.io.InputStream;

import org.apache.commons.io.IOUtils;

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

        try {
    InputStream is = new FileInputStream("/home/files/PropertyGroups.xml");
    ws.registerDefinition(is);
    IOUtils.closeQuietly(is);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getSuggestions

Descripción:

Método	Valores de retorno	Descripción
getSuggestions(String nodeId, String grpName, String propName)	List	Recupera una lista de valores sugeridos para un campo de metadatos.

El siguiente ejemplo se basa en esta definición de grupo de metadatos:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE property-groups PUBLIC "-//OpenKM//DTD Property Groups 2.0//EN"
                                 "http://www.openkm.com/dtd/property-groups-2.0.dtd">
<property-groups>
  <property-group label="Technology" name="okg:technology">
    <select label="Type" name="okp:technology.type" type="multiple">
      <option label="Alfa" value="t1"/>
      <option label="Beta" value="t2" />
      <option label="Omega" value="t3" />
    </select>
    <select label="Language" name="okp:technology.language" type="simple">
      <option label="Java" value="java"/>
      <option label="Python" value="python"/>
      <option label="PHP" value="php" />
    </select>
    <input label="Comment" name="okp:technology.comment"/>
    <textarea label="Description" name="okp:technology.description"/>
    <input label="Link" type="link" name="okp:technology.link"/>
  </property-group>
</property-groups>

Ejemplo:

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

        try {
    for (String value : ws.getSuggestions("/okm:root/logo.pdf","okg:technology", "okp:technology.language")) {
     System.out.println(value);
    }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getPropertyGroupPropertiesSimple

Descripción:

Método	Valores de retorno	Descripción
getPropertyGroupPropertiesSimple(String nodeId, String grpName)	Map<String, String>	Recupera un mapa - pares (clave, valor) - con los valores del grupo de metadatos de un nodo.

Ejemplo:

package com.openkm;

import java.util.HashMap;
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 username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);

        try {
    Map<String, String> properties = new HashMap<>();
    properties = ws.getPropertyGroupPropertiesSimple("/okm:root/logo.pdf","okg:technology");

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