View Javadoc

1   /* This file is part of the project "Hilbert II" - http://www.qedeq.org" target="alexandria_uri">http://www.qedeq.org
2    *
3    * Copyright 2000-2014,  Michael Meyling <mime@qedeq.org>.
4    *
5    * "Hilbert II" is free software; you can redistribute
6    * it and/or modify it under the terms of the GNU General Public
7    * License as published by the Free Software Foundation; either
8    * version 2 of the License, or (at your option) any later version.
9    *
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.service.unicode;
17  
18  import org.qedeq.base.io.SourcePosition;
19  
20  
21  /**
22   * QEDEQ module reference finder.
23   *
24   * @author  Michael Meyling
25   */
26  public interface ReferenceFinder {
27  
28      /**
29       * Return string for reference link.
30       *
31       * @param   reference       Link to this.
32       * @param   startDelta      Absolute source position start of reference.
33       * @param   endDelta        Absolute source position end of reference.
34       * @return  Return reference as string.
35       */
36      public String getReferenceLink(final String reference,
37          final SourcePosition startDelta, final SourcePosition endDelta);
38  
39      /**
40       * Add warning.
41       *
42       * @param   code        Warning code.
43       * @param   msg         Warning message.
44       * @param   startDelta  Skip position relative to location start).
45       * @param   endDelta    Mark until this column (relative to location start).
46       */
47      public void addWarning(final int code, final String msg, final SourcePosition startDelta,
48              final SourcePosition endDelta);
49  
50  }