Package: EMFFormsSpreadsheetFormatDescriptionProvider

EMFFormsSpreadsheetFormatDescriptionProvider

Coverage

1: /*******************************************************************************
2: * Copyright (c) 2015 Innoopract Informationssysteme GmbH and others.
3: *
4: * All rights reserved. This program and the accompanying materials
5: * are made available under the terms of the Eclipse Public License 2.0
6: * which accompanies this distribution, and is available at
7: * https://www.eclipse.org/legal/epl-2.0/
8: *
9: * SPDX-License-Identifier: EPL-2.0
10: *
11: * Contributors:
12: * Innoopract Informationssysteme GmbH - initial API and implementation
13: * EclipseSource - ongoing implementation
14: ******************************************************************************/
15: package org.eclipse.emfforms.spi.spreadsheet.core;
16:
17: import org.eclipse.emf.ecore.EStructuralFeature;
18:
19: /**
20: * A service that translates the format and the constraint information for a given structural feature into a human
21: * readable string that can be used to provide guidance when filling out a spreadsheet. A default implementation is
22: * provided by EMFFormsSpreadsheetFormatDescriptionProviderImpl; it can be overridden by providing a OSGi service
23: * instance with a higher priority.
24: */
25: public interface EMFFormsSpreadsheetFormatDescriptionProvider {
26:
27:         /**
28:          * Based on the given structural feature a human readable format string is being computed; this string is meant to
29:          * help a user to fill out forms in a spreadsheet.
30:          *
31:          * @param structuralFeature used for the format description.
32:          * @return A string that describes the format and the constraints of the structural feature.
33:          */
34:         String getFormatDescription(EStructuralFeature structuralFeature);
35:
36: }