org.jodconverter.office.utils.Lo Maven / Gradle / Ivy
Show all versions of jodconverter-local Show documentation
/*
* Copyright 2004 - 2012 Mirko Nasato and contributors
* 2016 - 2020 Simon Braconnier and contributors
*
* This file is part of JODConverter - Java OpenDocument Converter.
*
* Licensed 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.jodconverter.office.utils;
import java.util.Optional;
import com.sun.star.lang.XComponent;
import com.sun.star.lang.XMultiServiceFactory;
import com.sun.star.uno.Exception;
import com.sun.star.uno.UnoRuntime;
import com.sun.star.uno.XComponentContext;
/**
* A collection of utility functions to make Office easier to use.
*
* Inspired by the work of Dr. Andrew Davison from the website Java LibreOffice Programming.
*/
public final class Lo {
// Document types service names
public static final String UNKNOWN_SERVICE = "com.sun.frame.XModel";
// NOTE: a GenericTextDocument is either a TextDocument, a WebDocument, or a GlobalDocument
// public static final String WRITER_SERVICE = "com.sun.star.text.TextDocument";
public static final String WRITER_SERVICE = "com.sun.star.text.GenericTextDocument";
public static final String BASE_SERVICE = "com.sun.star.sdb.OfficeDatabaseDocument";
public static final String CALC_SERVICE = "com.sun.star.sheet.SpreadsheetDocument";
public static final String DRAW_SERVICE = "com.sun.star.drawing.DrawingDocument";
public static final String IMPRESS_SERVICE = "com.sun.star.presentation.PresentationDocument";
public static final String MATH_SERVICE = "com.sun.star.formula.FormulaProperties";
/**
* Queries the given UNO object for the given Java class (which must represent a UNO interface
* type).
*
* @param The requested UNO interface type.
* @param type A Java class representing a UNO interface type.
* @param object A reference to any Java object representing (a facet of) a UNO object; may be
* null.
* @return A reference to the requested UNO interface type if available, otherwise null
* .
* @see UnoRuntime#queryInterface(Class, Object)
*/
public static T qi(final Class type, final Object object) {
return UnoRuntime.queryInterface(type, object);
}
/**
* Queries the given UNO object for the given Java class (which must represent a UNO interface
* type).
*
* @param the requested UNO interface type.
* @param type A Java class representing a UNO interface type.
* @param object A reference to any Java object representing (a facet of) a UNO object; may be
* null.
* @return A reference to the requested UNO interface type if available, otherwise null
* .
* @see UnoRuntime#queryInterface(Class, Object)
*/
public static Optional qiOptional(final Class type, final Object object) {
return Optional.ofNullable(UnoRuntime.queryInterface(type, object));
}
/**
* Gets the XMultiServiceFactory for the given component.
*
* @param component The component.
* @return The service factory.
*/
public static XMultiServiceFactory getServiceFactory(final XComponent component) {
return qi(XMultiServiceFactory.class, component);
}
/**
* Create an interface object of the given class from the given named service; uses given
* XComponent and 'old' XMultiServiceFactory, so a document must have been already loaded/created.
*
* @param The requested UNO interface type.
* @param component The component.
* @param type A Java class representing a UNO interface type.
* @param serviceName The service name.
* @return A reference to the requested UNO interface type if available, otherwise null
* .
* @throws WrappedUnoException If an UNO exception occurs. The UNO exception will be the cause of
* the {@link WrappedUnoException}.
*/
public static T createInstanceMSF(
final XComponent component, final Class type, final String serviceName) {
// Create service component using the specified factory.
// Then uses bridge to obtain proxy to remote interface inside service;
// implements casting across process boundaries
return createInstanceMSF(getServiceFactory(component), type, serviceName);
}
/**
* Create an interface object of the given class from the given named service; uses given 'old'
* XMultiServiceFactory, so a document must have been already loaded/created.
*
* @param The requested UNO interface type.
* @param factory The service factory.
* @param type A Java class representing a UNO interface type.
* @param serviceName The service name.
* @return A reference to the requested UNO interface type if available, otherwise null
* .
* @throws WrappedUnoException If an UNO exception occurs. The UNO exception will be the cause of
* the {@link WrappedUnoException}.
*/
public static T createInstanceMSF(
final XMultiServiceFactory factory, final Class type, final String serviceName) {
// Create service component using the specified factory.
// Then uses bridge to obtain proxy to remote interface inside service;
// implements casting across process boundaries
try {
return qi(type, factory.createInstance(serviceName));
} catch (Exception ex) {
throw new WrappedUnoException(ex.getMessage(), ex);
}
}
/**
* Create an interface object of the given class from the given named service; uses given
* XComponentContext and 'new' XMultiComponentFactory so only a bridge to office is needed.
*
* @param The requested UNO interface type.
* @param context The component context.
* @param type A Java class representing a UNO interface type.
* @param serviceName The service name.
* @return A reference to the requested UNO interface type if available, otherwise null
* .
* @throws WrappedUnoException If an UNO exception occurs. The UNO exception will be the cause of
* the {@link WrappedUnoException}.
*/
public static T createInstanceMCF(
final XComponentContext context, final Class type, final String serviceName)
throws WrappedUnoException {
// Create service component using the specified component context.
// Then uses bridge to obtain proxy to remote interface inside service;
// implements casting across process boundaries
try {
return qi(type, context.getServiceManager().createInstanceWithContext(serviceName, context));
} catch (Exception ex) {
throw new WrappedUnoException(ex);
}
}
// Suppresses default constructor, ensuring non-instantiability.
private Lo() {
throw new AssertionError("Utility class must not be instantiated");
}
}