1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
|
package de.lmu.ifi.dbs.elki.data;
/*
This file is part of ELKI:
Environment for Developing KDD-Applications Supported by Index-Structures
Copyright (C) 2012
Ludwig-Maximilians-Universität München
Lehr- und Forschungseinheit für Datenbanksysteme
ELKI Development Team
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
import java.util.regex.Pattern;
import de.lmu.ifi.dbs.elki.data.type.SimpleTypeInformation;
/**
* A HierarchicalClassLabel is a ClassLabel to reflect a hierarchical structure
* of classes.
*
* @author Arthur Zimek
*
* @apiviz.composedOf Comparable
*/
public class HierarchicalClassLabel extends ClassLabel {
/**
* The default separator pattern, a point ('.').
*/
public static final Pattern DEFAULT_SEPARATOR = Pattern.compile("\\.");
/**
* The default separator, a point ('.').
*/
public static final String DEFAULT_SEPARATOR_STRING = ".";
/**
* Type information.
*/
public static final SimpleTypeInformation<HierarchicalClassLabel> TYPE = new SimpleTypeInformation<HierarchicalClassLabel>(HierarchicalClassLabel.class);
/**
* Holds the Pattern to separate different levels parsing input.
*/
private Pattern separatorPattern;
/**
* A String to separate different levels in a String representation of this
* HierarchicalClassLabel.
*/
private String separatorString;
/**
* Holds the names on the different levels.
*/
private Comparable<?>[] levelwiseNames;
/**
* Constructs a hierarchical class label from the given name, using the given
* Pattern to match separators of different levels in the given name, and
* setting the given separator-String to separate different levels in String
* representations of this HierarchicalClassLabel.
*
* @param name a String describing a hierarchical class label
* @param regex a Pattern to match separators of different levels in the given
* name
* @param separator a separator String to separate different levels in the
* String-representation of this HierarchicalClassLabel
*/
public HierarchicalClassLabel(String name, Pattern regex, String separator) {
super();
this.separatorPattern = regex;
this.separatorString = separator;
String[] levelwiseStrings = separatorPattern.split(name);
this.levelwiseNames = new Comparable<?>[levelwiseStrings.length];
for (int i = 0; i < levelwiseStrings.length; i++) {
try {
levelwiseNames[i] = Integer.valueOf(levelwiseStrings[i]);
} catch (NumberFormatException e) {
levelwiseNames[i] = levelwiseStrings[i];
}
}
}
/**
* Constructs a hierarchical class label from the given name. Different levels
* are supposed to be separated by points ('.'), as defined by
* {@link #DEFAULT_SEPARATOR DEFAULT_SEPARATOR}. Also, in a
* String-representation of this HierarchicalClassLabel, different levels get
* separated by '.'.
*
* @param label a String describing a hierarchical class label
*/
public HierarchicalClassLabel(String label) {
this(label, DEFAULT_SEPARATOR, DEFAULT_SEPARATOR_STRING);
}
/**
* Compares two HierarchicalClassLabels. Names at higher levels are compared
* first. Names at a lower level are compared only if their parent-names are
* equal. Names at a level are tried to be compared as integer values. If this
* does not succeed, both names are compared as Strings.
*
* {@inheritDoc}
*/
@SuppressWarnings({ "unchecked", "rawtypes" })
@Override
public int compareTo(ClassLabel o) {
HierarchicalClassLabel h = (HierarchicalClassLabel) o;
for (int i = 0; i < this.levelwiseNames.length && i < h.levelwiseNames.length; i++) {
int comp = 0;
try {
Comparable first = this.levelwiseNames[i];
Comparable second = h.levelwiseNames[i];
comp = first.compareTo(second);
} catch (RuntimeException e) {
String h1 = (String) (this.levelwiseNames[i] instanceof Integer ? this.levelwiseNames[i].toString() : this.levelwiseNames[i]);
String h2 = (String) (h.levelwiseNames[i] instanceof Integer ? h.levelwiseNames[i].toString() : h.levelwiseNames[i]);
comp = h1.compareTo(h2);
}
if (comp != 0) {
return comp;
}
}
return (this.levelwiseNames.length < h.levelwiseNames.length) ? -1 : ((this.levelwiseNames.length == h.levelwiseNames.length) ? 0 : 1);
}
/**
* The length of the hierarchy of names.
*
* @return length of the hierarchy of names
*/
public int depth() {
return levelwiseNames.length - 1;
}
/**
* Returns the name at the given level as a String.
*
* @param level the level to return the name at
* @return the name at the given level as a String
*/
public String getNameAt(int level) {
return this.levelwiseNames[level] instanceof Integer ? this.levelwiseNames[level].toString() : (String) this.levelwiseNames[level];
}
/**
* Returns a String representation of this HierarchicalClassLabel using
* {@link #separatorString separatorString} to separate levels.
*
* {@inheritDoc}
*/
@Override
public String toString() {
return toString(levelwiseNames.length);
}
/**
* Provides a String representation of this ClassLabel comprising only the
* first <code>level</code> levels.
*
* @param level the lowest level to include in the String representation.
* @return a String representation of this ClassLabel comprising only the
* first <code>level</code> levels
*/
public String toString(int level) {
if (level > levelwiseNames.length) {
throw new IllegalArgumentException("Specified level exceeds depth of hierarchy.");
}
StringBuilder name = new StringBuilder();
for (int i = 0; i < level; i++) {
name.append(this.getNameAt(i));
if (i < level - 1) {
name.append(this.separatorString);
}
}
return name.toString();
}
/**
* Factory class.
*
* @author Erich Schubert
*
* @apiviz.has HierarchicalClassLabel - - «creates»
* @apiviz.stereotype factory
*/
public static class Factory extends ClassLabel.Factory<HierarchicalClassLabel> {
@Override
public HierarchicalClassLabel makeFromString(String lbl) {
lbl = lbl.intern();
HierarchicalClassLabel l = existing.get(lbl);
if (l == null) {
l = new HierarchicalClassLabel(lbl);
existing.put(lbl, l);
}
return l;
}
@Override
public SimpleTypeInformation<? super HierarchicalClassLabel> getTypeInformation() {
return TYPE;
}
}
}
|
