<commit_before>/*
 * Copyright (c) 2012 Diamond Light Source Ltd.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 */

package org.dawb.common.services.conversion;

/**
 * This service is available as an OSGI service similar to IPersistenceService.
 * 
 * An OSGI Service can be used from anywhere in an OSG environment such as vergil
 * or equinox.
 * 
 * Usage something like:
 * <code>
 * IConversionService service = (IConversionService)ServiceManager.getService(IConversionService.class);
 * IConversionContext context = service.open("/dls/path_to_some_hdf5_file.nxs"); // regex allowed
 * context.setDatasetName("/entry1/signal/some_data"); // regex allowed
 * context.setOutputPath("/dls/some_place_I_want_my_data");
 * context.setScheme(IConversionContext.ConversionScheme.ASCII_FROM_2D);
 * service.process(context);
 * </code>
 * 
 * The core service supports looping, slicing and dicing etc.
 * 
 * Two methods for adding your own conversion:
 * 
 * 1. 
 * 1.1 Extend the enum ConversionScheme to have your new conversion.
 * 1.2 Add an implementation of it in org.dawnsci.conversion.internal
 * 1.3 Change method process(...) in ConversionServiceImpl to use this new scheme and class.
 * 
 * 2.
 * 2.1 Create a new class implementing IConversionVisitor
 * 2.2 Set this visitor on the context using IConversionContext.setConversionVisitor(...)
 * 2.3 Call conversion as normal, each slice will be sent for the visitor to do the writing.
 * 
 * 
 * TODO FIXME Move this service to org.eclipse.dawnsci.conversion with few dependencies.
 */
public interface IConversionService {<commit_msg>Fixed javadoc<commit_after>/*
 * Copyright (c) 2012 Diamond Light Source Ltd.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 */

package org.dawb.common.services.conversion;

/**
 * This service is available as an OSGI service similar to IPersistenceService.
 * 
 * An OSGI Service can be used from anywhere in an OSG environment such as vergil
 * or equinox.
 * 
 * Usage something like:
 * <code>
 * IConversionService service = (IConversionService)ServiceManager.getService(IConversionService.class);
 * IConversionContext context = service.open("/dls/path_to_some_hdf5_file.nxs"); // regex allowed
 * context.setDatasetName("/entry1/signal/some_data"); // regex allowed
 * context.setOutputPath("/dls/some_place_I_want_my_data");
 * context.setConversionScheme(IConversionContext.ConversionScheme.ASCII_FROM_2D);
 * service.process(context);
 * </code>
 * 
 * The core service supports looping, slicing and dicing etc.
 * 
 * Two methods for adding your own conversion:
 * 
 * 1. 
 * 1.1 Extend the enum ConversionScheme to have your new conversion.
 * 1.2 Add an implementation of it in org.dawnsci.conversion.internal
 * 1.3 Change method process(...) in ConversionServiceImpl to use this new scheme and class.
 * 
 * 2.
 * 2.1 Create a new class implementing IConversionVisitor
 * 2.2 Set this visitor on the context using IConversionContext.setConversionVisitor(...)
 * 2.3 Call conversion as normal, each slice will be sent for the visitor to do the writing.
 * 
 * 
 * TODO FIXME Move this service to org.eclipse.dawnsci.conversion with few dependencies.
 */
public interface IConversionService {
{'fraction_non_alphanumeric': 0.08869179600886919, 'fraction_numerical': 0.01385809312638581, 'mean_word_length': 4.215317919075145, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 0, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1924200', 'n_tokens_mistral': 1069, 'n_tokens_neox': 1008, 'n_words': 365}