-
Notifications
You must be signed in to change notification settings - Fork 1
/
Token.py
228 lines (197 loc) · 7.24 KB
/
Token.py
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
219
220
221
222
223
224
225
226
227
228
#!/usr/bin/env python3
# -*- coding: utf-8, vim: expandtab:ts=4 -*-
from TokenProperty import *
import re
from operator import attrgetter
"""
* A Token represents a word in an utterance. It consists of an index and a set of properties with name and value.
*
* @author Sebastian Riedel
"""
class Token:
"""
* The index of the token.
"""
@property
def index(self):
return self._index
@index.setter
def index(self, value):
self._index = value
"""
* A mapping from properties to values.
"""
@property
def tokenProperties(self):
return self._tokenProperties
@tokenProperties.setter
def tokenProperties(self, value):
self._tokenProperties = value
"""
* Creates a new token with the given index.
*
* @param index the index of the token.
"""
def __init__(self, index):
self._index = index
self._tokenProperties = {}
"""
* Returns the index of the token.
*
* @return the index of the token.
"""
# See the getter above...
"""
* Return all token properties (the property names). To get the value of a property use {@link
* Token#getProperty(TokenProperty)}.
*
* @return a collection with token properties.
"""
def getPropertyTypes(self):
return tuple(self._tokenProperties.keys())
"""
* Get the value of the given property.
*
* @param property the property to get the value for.
* @return the value of the given property.
"""
def getProperty(self, property):
return self._tokenProperties[property]
"""
* Remove the property value with given index.
*
* @param index the index of the property to remove.
OR
* Remove the property value with the given name.
*
* @param name the name of the property to remove.
"""
def removeProperty(self, name=None, index=None):
if index is not None:
del self._tokenProperties[TokenProperty(name=name)]
if name is not None:
del self._tokenProperties[TokenProperty(level=index)]
"""
* Add a property with the given name and value.
*
* @param name the name of the property.
* @param value the value of the property.
* @return a pointer to this token.
OR
* Add the property with name "Property [index]" and the given value.
*
* @param index the index of the property
* @param property the value of the property.
OR
* Add a property with given value.
*
* @param property the property to add
* @param value the value of the property
* @return this token.
* Adds a property with the given value. The property name will be "Property i" where i this the current number of
* properties.
*
* @param value the value of the property.
"""
def addProperty(self, value=None, name=None, index=None, property=None):
if name is not None and value is not None:
self._tokenProperties[TokenProperty(name=name, level=len(self._tokenProperties))] = value
return self
if index is not None and property is not None:
self._tokenProperties[TokenProperty(level=self._tokenProperties[index])] = property
return None # !!
if property is not None and value is not None:
self._tokenProperties[property] = value
return self
if value is not None:
self._tokenProperties[TokenProperty(level=self._tokenProperties[len(self._tokenProperties)])] = value
return None # !!
"""
* Sorts the properties by property level and name.
*
* @return a list of sorted token properties.
"""
def getSortedProperties(self):
sorted_properties = sorted(self._tokenProperties.keys(), key=attrgetter('level','name'))
return list(sorted_properties)
"""
* Returns a collection of all property values.
*
* @return a collection of all property values.
"""
# See the getter above...
"""
* Check whether any of the property values contains the given string.
*
* @param substring the string to check whether it is contained in any property value of this token.
* @return true iff there exists on property of this token for which <code>substring</code> is a substring of the
* corresponding property value.
OR
* Check whether any of the property values of this token contains any of the strings in the given set of strings.
*
* @param substrings set of strings to check
* @param wholeWord should we check for complete words of is it enough for the given strings to be substrings of
* the token value.
* @return true iff a) if there is a property value equal to one of the strings in <code>substrings</code>
* (wholeword=true) or b) if there is a property value that contains one of the strings in
* <code>substrings</code> (wholeword=false).
"""
def propertiesContain(self, substring=None, substrings=None, wholeWord=None):
if substring is not None:
for property in self._tokenProperties.values():
if substring in property:
return True
return False
else:
if substrings is not None and wholeWord is not None:
for property in self._tokenProperties.values():
for substr in substrings:
if re.match("\d+-\d+$", substr): # Full string match in JAVA!
From, To = substr.split("-")
if int(From) <= property <= int(To):
return True
elif (wholeWord and property == substr) or (not wholeWord and substr in property):
return True
return False
"""
* Checks whether the two tokens have the same index. (Hence equality is only defined through the position of the
* token in the sentence.
*
* @param o the other token.
* @return <code>index==((Token)o).index</code>
"""
def __eq__(self, other):
return other is not None and isinstance(other, self.__class__) and self._index == other.index
"""
* Returns the index of the token.
*
* @return the index of the token.
"""
def __hash__(self):
return int(self.index)
"""
* Inserts all properties and values of the other token into this token. In case of clashes the value of the other
* token is taken.
*
* @param token the token to merge with.
"""
def merge(self, token):
self._tokenProperties.update(token.tokenProperties)
"""
* Compares the indices of both tokens.
*
* @param o the other token.
* @return <code>index - o.getIndex()</code>
"""
def compareTo(self, other):
return self._index - other.index
"""
* Returns a string representation of this token containing token index and properties.
*
* @return a string representation of this token.
"""
def __str__(self):
return "{0}:{1}".format(self._index, ", ".join(str(prop) for prop in self._tokenProperties))
@property
def int_index(self):
return int(self._index)