|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.gisgraphy.domain.valueobject.Output
public class Output
Represent an output specification.
Nested Class Summary | |
---|---|
static class |
Output.OutputFormat
All the possible fulltext search output format, all the OUTPUFORMAT enum should be in uppercase |
static class |
Output.OutputStyle
All the possible fulltext search output style verbosity Short (basic informations) : feature_id, name, fully_qualified_name, zipcode (if city), placetype, country_code, country_name Medium (More informations) : Short + lat, lon, feature_class, feature_code, population, fips Long (AlternateNames +adm informations) : Medium + alternateNames, adm1_name, adm2_name, adm3_name, Adm4_name, adm1_code, Adm2_code, Adm3_code, Adm4_code Full (alternatenames for adm and country): Long + country_alternate_name_, adm1_alternate_name_, adm2_alternate_name_ |
Field Summary | |
---|---|
static java.lang.String |
DEFAULT_LANGUAGE_CODE
The Default languageCode |
static Output |
DEFAULT_OUTPUT
Output with default values |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object obj)
|
java.lang.String |
getFields()
|
Output.OutputFormat |
getFormat()
|
java.lang.String |
getLanguageCode()
|
Output.OutputStyle |
getStyle()
|
int |
hashCode()
|
boolean |
isIndented()
|
java.lang.String |
toString()
|
static Output |
withDefaultFormat()
|
static Output |
withFormat(Output.OutputFormat format)
|
Output |
withIndentation()
This method force the output to be indented |
Output |
withLanguageCode(java.lang.String languageCode)
|
Output |
withStyle(Output.OutputStyle style)
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String DEFAULT_LANGUAGE_CODE
languageCode
public static final Output DEFAULT_OUTPUT
Method Detail |
---|
public static Output withFormat(Output.OutputFormat format)
format
- The format the output shoud have
public static Output withDefaultFormat()
Output.OutputFormat.getDefault()
public java.lang.String getFields()
getLanguageCode()
and Output.OutputStyle
(the
fields return by the full text search engine)public Output.OutputFormat getFormat()
Output.OutputFormat.getDefault()
withFormat(com.gisgraphy.domain.valueobject.Output.OutputFormat)
public java.lang.String getLanguageCode()
DEFAULT_LANGUAGE_CODE
withLanguageCode(String)
public Output.OutputStyle getStyle()
Output.OutputStyle.getDefault()
withStyle(com.gisgraphy.domain.valueobject.Output.OutputStyle)
public boolean isIndented()
withIndentation()
public Output withIndentation()
public Output withLanguageCode(java.lang.String languageCode)
languageCode
- The iso639Alpha2 LanguageCode parameter that the output
format should be, the fulltext results will be in the
specified language The language code can be null or a non
existing language code (no check is done).if the specified
languageCode is null or an empty string, it will be set to
null
public Output withStyle(Output.OutputStyle style)
style
- The verbosity style parameter that the output format
should have, the output will include more or less data
according to the specified style
public java.lang.String toString()
toString
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |