org.apache.tika.config.Param Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aem-sdk-api Show documentation
Show all versions of aem-sdk-api Show documentation
The Adobe Experience Manager SDK
The newest version!
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.tika.config;
import org.apache.tika.exception.TikaException;
import org.apache.tika.utils.XMLReaderUtils;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerException;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.Serializable;
import java.lang.reflect.Constructor;
import java.lang.reflect.InvocationTargetException;
import java.math.BigInteger;
import java.net.URI;
import java.net.URL;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* This is a serializable model class for parameters from configuration file.
*
* @param value type. Should be serializable to string and have a constructor with string param
* @since Apache Tika 1.14
*/
public class Param implements Serializable {
private static final String LIST = "list";
private static final Map, String> map = new HashMap<>();
private static final Map> reverseMap = new HashMap<>();
private static final Map> wellKnownMap = new HashMap<>();
static {
map.put(Boolean.class, "bool");
map.put(String.class, "string");
map.put(Byte.class, "byte");
map.put(Short.class, "short");
map.put(Integer.class, "int");
map.put(Long.class, "long");
map.put(BigInteger.class, "bigint");
map.put(Float.class, "float");
map.put(Double.class, "double");
map.put(File.class, "file");
map.put(URI.class, "uri");
map.put(URL.class, "url");
map.put(ArrayList.class, LIST);
for (Map.Entry, String> entry : map.entrySet()) {
reverseMap.put(entry.getValue(), entry.getKey());
}
//wellKnownMap.put("metadataPolicy", AbstractMultipleParser.MetadataPolicy.class);
}
private Class type;
private String name;
private List valueStrings = new ArrayList<>();
private T actualValue;
public Param(){
}
public Param(String name, Class type, T value) {
this.name = name;
this.type = type;
this.actualValue = value;
if (List.class.isAssignableFrom(value.getClass())) {
this.valueStrings.addAll((List)value);
} else {
this.valueStrings.add(value.toString());
}
if (this.type == null) {
this.type = (Class)wellKnownMap.get(name);
}
}
public Param(String name, T value){
this(name, (Class) value.getClass(), value);
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public Class getType() {
return type;
}
public void setType(Class type) {
this.type = type;
}
public String getTypeString(){
if (type == null) {
return null;
}
if (List.class.isAssignableFrom(type)) {
return LIST;
}
if (map.containsKey(type)){
return map.get(type);
}
return type.getName();
}
public void setTypeString(String type){
if (type == null || type.isEmpty()){
return;
}
this.type = classFromType(type);
this.actualValue = null;
}
public T getValue(){
return actualValue;
}
@Override
public String toString() {
return "Param{" +
"name='" + name + '\'' +
", valueStrings='" + valueStrings + '\'' +
", actualValue=" + actualValue +
'}';
}
public void save(OutputStream stream) throws TransformerException, TikaException {
DocumentBuilder builder = XMLReaderUtils.getDocumentBuilder();
Document doc = builder.newDocument();
Element paramEl = doc.createElement("param");
doc.appendChild(paramEl);
save(doc, paramEl);
Transformer transformer = XMLReaderUtils.getTransformer();
transformer.transform(new DOMSource(paramEl), new StreamResult(stream));
}
public void save(Document doc, Node node) {
if ( !(node instanceof Element) ) {
throw new IllegalArgumentException("Not an Element : " + node);
}
Element el = (Element) node;
el.setAttribute("name", getName());
el.setAttribute("type", getTypeString());
if (List.class.isAssignableFrom(actualValue.getClass())) {
for (int i = 0; i < valueStrings.size(); i++) {
String val = valueStrings.get(i);
String typeString = map.get(((List)actualValue).get(i).getClass());
Node item = doc.createElement(typeString);
item.setTextContent(val);
el.appendChild(item);
}
} else {
el.setTextContent(valueStrings.get(0));
}
}
public static Param load(InputStream stream) throws SAXException, IOException, TikaException {
DocumentBuilder db = XMLReaderUtils.getDocumentBuilder();
Document document = db.parse(stream);
return load(document.getFirstChild());
}
public static Param load(Node node) {
Node nameAttr = node.getAttributes().getNamedItem("name");
Node typeAttr = node.getAttributes().getNamedItem("type");
Node valueAttr = node.getAttributes().getNamedItem("value");
Node value = node.getFirstChild();
if (value instanceof NodeList && valueAttr != null) {
throw new IllegalArgumentException("can't specify a value attr _and_ a node list");
}
if (valueAttr != null && (value == null || value.getTextContent() == null)) {
value = valueAttr;
}
Param ret = new Param();
ret.name = nameAttr.getTextContent();
if (typeAttr != null) {
ret.setTypeString(typeAttr.getTextContent());
} else {
ret.type = (Class)wellKnownMap.get(ret.name);
}
if (List.class.isAssignableFrom(ret.type)) {
loadList(ret, node);
} else {
ret.actualValue = getTypedValue(ret.type, value.getTextContent());
ret.valueStrings.add(value.getTextContent());
}
return ret;
}
private static void loadList(Param ret, Node root) {
Node child = root.getFirstChild();
ret.actualValue = (T)new ArrayList<>();
while (child != null) {
if (child.getNodeType() == Node.ELEMENT_NODE) {
Class type = classFromType(child.getLocalName());
((List) ret.actualValue).add(getTypedValue(type, child.getTextContent()));
ret.valueStrings.add(child.getTextContent());
}
child = child.getNextSibling();
}
}
private static Class classFromType(String type) {
if (reverseMap.containsKey(type)){
return (Class) reverseMap.get(type);
} else try {
return (Class) Class.forName(type);
} catch (ClassNotFoundException e) {
throw new RuntimeException(e);
}
}
private static T getTypedValue(Class type, String value) {
try {
if (type.isEnum()) {
Object val = Enum.valueOf((Class)type, value);
return (T)val;
}
Constructor constructor = type.getConstructor(String.class);
constructor.setAccessible(true);
return constructor.newInstance(value);
} catch (NoSuchMethodException e) {
throw new RuntimeException(type + " doesnt have a constructor that takes String arg", e);
} catch (IllegalAccessException | InstantiationException | InvocationTargetException e) {
throw new RuntimeException(e);
}
}
}