Element2Utf8.java
01 /* This file is part of the project "Hilbert II" - http://www.qedeq.org
02  *
03  * Copyright 2000-2013,  Michael Meyling <mime@qedeq.org>.
04  *
05  * "Hilbert II" is free software; you can redistribute
06  * it and/or modify it under the terms of the GNU General Public
07  * License as published by the Free Software Foundation; either
08  * version 2 of the License, or (at your option) any later version.
09  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  */
15 
16 package org.qedeq.kernel.bo.common;
17 
18 import org.qedeq.kernel.se.base.list.Element;
19 
20 /**
21  * Transfer a QEDEQ formula or term into UTF-8 text.
22  *
23  @author  Michael Meyling
24  */
25 public interface Element2Utf8 {
26 
27     /**
28      * Get UTF-8 element presentation.
29      *
30      @param   element     Print this element.
31      @return  UTF-8 form of element.
32      */
33     public abstract String getUtf8(final Element element);
34 
35 
36     /**
37      * Get an UTF-8 element presentation that doesn't exceed the given maximum column
38      * length. If the presentation doesn't fit into one row it is split and several rows
39      * are returned.
40      *
41      @param   element     Print this element.
42      @param   maxCols     Maximum column number. If equal or below zero a maximum is
43      *                      neglected.
44      @return  UTF-8 form of element (might be one or several rows).
45      */
46     public abstract String[] getUtf8(final Element element, int maxCols);
47 
48 
49 }