/
FacetMetadata.java
78 lines (63 loc) · 1.84 KB
/
FacetMetadata.java
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
/*
* Hibernate Search, full-text search for your domain model
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later
* See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
*/
package org.hibernate.search.engine.metadata.impl;
import org.hibernate.search.annotations.FacetEncodingType;
/**
* Encapsulating the metadata for a facet on a given document field.
*
* @author Hardy Ferentschik
*/
public class FacetMetadata {
private final String absoluteName;
private final String relativeName;
private final FacetEncodingType encoding;
private FacetMetadata(Builder builder) {
this.absoluteName = builder.absoluteName;
this.relativeName = builder.relativeName;
this.encoding = builder.encoding;
}
/**
* @return The full name of the facet field, including any indexed-embedded prefix.
*/
public String getAbsoluteName() {
return absoluteName;
}
/**
* @return The name of the facet field excluding any indexed-embedded prefix.
*/
public String getRelativeName() {
return relativeName;
}
public FacetEncodingType getEncoding() {
return encoding;
}
public static class Builder {
// required parameters
private final String absoluteName;
private final String relativeName;
// optional parameters
private FacetEncodingType encoding = FacetEncodingType.AUTO;
public Builder(String absoluteName, String relativeName) {
this.absoluteName = absoluteName;
this.relativeName = relativeName;
}
public void setFacetEncoding(FacetEncodingType encoding) {
this.encoding = encoding;
}
public FacetMetadata build() {
return new FacetMetadata( this );
}
}
@Override
public String toString() {
return "FacetMetadata{" +
"absoluteName='" + absoluteName + '\'' +
"relativeName='" + relativeName + '\'' +
", encoding=" + encoding +
'}';
}
}