BrowseUtil

java.lang.Object
- com.boomi.connector.api.BrowseUtil

```
public class BrowseUtil
extends Object
```
Utility methods for browsing

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ANNOTATIONS` Constant indicating the name of the Annotations node (JSON) that Boomi annotation resides in
`static String`	`BOOMI_ANNOTATION_DATAFORMAT` Constant indicating the name of the Data Format element
`static String`	`BOOMI_ANNOTATION_DATATYPE` Constant indicating the name of the dataType attribute
`static String`	`BOOMI_ANNOTATION_FIELD` Constant indicating the name of the Field element
`static String`	`BOOMI_ANNOTATION_FIELD_FILTERABLE` Constant indicating the name of the filterable attribute
`static String`	`BOOMI_ANNOTATION_FIELD_NAME` Constant indicating the name of the name attribute
`static String`	`BOOMI_ANNOTATION_FIELD_SELECTABLE` Constant indicating the name of the selectable attribute
`static String`	`BOOMI_ANNOTATION_FIELD_SELECTED` Constant indicating the name of the selected attribute
`static String`	`BOOMI_ANNOTATION_FIELD_SORTABLE` Constant indicating the name of the sortable attribute
`static String`	`BOOMI_ANNOTATION_FIELD_TYPE` Constant indicating the name of the type attribute
`static String`	`BOOMI_ANNOTATION_FIELD_TYPE_NS` Constant indicating the name of the type namespace attribute
`static String`	`BOOMI_ANNOTATION_FIELDSPEC` Constant indicating the name of the Field Specification element
`static String`	`BOOMI_ANNOTATION_FILTER` Constant indicating the name of the Filter element
`static String`	`BOOMI_ANNOTATION_FILTER_IGNORE` Constant indicating the name of the ignore attribute
`static String`	`BOOMI_ANNOTATION_FORMAT` Constant indicating the name of the format attribute
`static String`	`BOOMI_ANNOTATION_IGNORE_FOR_FILTERS` Constant indicating the name of the ignore filters attribute
`static String`	`BOOMI_ANNOTATION_IGNORE_FOR_SELECTION` Constant indicating the name of the ignore filters attribute
`static String`	`BOOMI_ANNOTATION_IGNORE_FOR_SORT` Constant indicating the name of the ignore filters attribute
`static String`	`BOOMI_ANNOTATION_JSON_DATAFORMAT` Constant indicating the name of the Data Format node (JSON)
`static String`	`BOOMI_ANNOTATION_JSON_FIELDS` Constant indicating the name of the Fields node (JSON)
`static String`	`BOOMI_ANNOTATION_JSON_FIELDSPEC` Constant indicating the name of the Field Specification node (JSON)
`static String`	`BOOMI_ANNOTATION_NAMESPACE` Constant indicating the namespace of the Filter annotation
`static String`	`BOOMI_FIELD_DELIMITER` Constant indicating the delimiter in for field names
`static Comparator<ObjectType>`	`OBJECT_TYPE_COMPARATOR` A Comparator which can be used to sort ObjectType's into lexicographical order.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Element`	`buildFilterElement(Document doc, boolean ignore)` Constructs a `Filter` element
`static Element`	`buildFilterElement(Document doc, boolean ignore, Collection<String> extraFilterFields)` Constructs a `Filter` element
`static Element`	`generateFieldElement(Document doc, String name)` Constructs a `Field` element

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - BOOMI_ANNOTATION_NAMESPACE
```
public static final String BOOMI_ANNOTATION_NAMESPACE
```
    Constant indicating the namespace of the Filter annotation
    
    See Also:
    
    Constant Field Values
  - BOOMI_ANNOTATION_FILTER
```
public static final String BOOMI_ANNOTATION_FILTER
```
    Constant indicating the name of the Filter element
    
    See Also:
    
    Constant Field Values
  - BOOMI_ANNOTATION_FIELDSPEC
```
public static final String BOOMI_ANNOTATION_FIELDSPEC
```
    Constant indicating the name of the Field Specification element
    
    See Also:
    
    Constant Field Values
  - BOOMI_ANNOTATION_FILTER_IGNORE
```
public static final String BOOMI_ANNOTATION_FILTER_IGNORE
```
    Constant indicating the name of the ignore attribute
    
    See Also:
    
    Constant Field Values
  - BOOMI_ANNOTATION_IGNORE_FOR_FILTERS
```
public static final String BOOMI_ANNOTATION_IGNORE_FOR_FILTERS
```
    Constant indicating the name of the ignore filters attribute
    
    See Also:
    
    Constant Field Values
  - BOOMI_ANNOTATION_IGNORE_FOR_SORT
```
public static final String BOOMI_ANNOTATION_IGNORE_FOR_SORT
```
    Constant indicating the name of the ignore filters attribute
    
    See Also:
    
    Constant Field Values
  - BOOMI_ANNOTATION_IGNORE_FOR_SELECTION
```
public static final String BOOMI_ANNOTATION_IGNORE_FOR_SELECTION
```
    Constant indicating the name of the ignore filters attribute
    
    See Also:
    
    Constant Field Values
  - BOOMI_ANNOTATION_FIELD
```
public static final String BOOMI_ANNOTATION_FIELD
```
    Constant indicating the name of the Field element
    
    See Also:
    
    Constant Field Values
  - BOOMI_ANNOTATION_FIELD_NAME
```
public static final String BOOMI_ANNOTATION_FIELD_NAME
```
    Constant indicating the name of the name attribute
    
    See Also:
    
    Constant Field Values
  - BOOMI_ANNOTATION_FIELD_TYPE
```
public static final String BOOMI_ANNOTATION_FIELD_TYPE
```
    Constant indicating the name of the type attribute
    
    See Also:
    
    Constant Field Values
  - BOOMI_ANNOTATION_FIELD_TYPE_NS
```
public static final String BOOMI_ANNOTATION_FIELD_TYPE_NS
```
    Constant indicating the name of the type namespace attribute
    
    See Also:
    
    Constant Field Values
  - BOOMI_ANNOTATION_FIELD_FILTERABLE
```
public static final String BOOMI_ANNOTATION_FIELD_FILTERABLE
```
    Constant indicating the name of the filterable attribute
    
    See Also:
    
    Constant Field Values
  - BOOMI_ANNOTATION_FIELD_SORTABLE
```
public static final String BOOMI_ANNOTATION_FIELD_SORTABLE
```
    Constant indicating the name of the sortable attribute
    
    See Also:
    
    Constant Field Values
  - BOOMI_ANNOTATION_FIELD_SELECTABLE
```
public static final String BOOMI_ANNOTATION_FIELD_SELECTABLE
```
    Constant indicating the name of the selectable attribute
    
    See Also:
    
    Constant Field Values
  - BOOMI_ANNOTATION_FIELD_SELECTED
```
public static final String BOOMI_ANNOTATION_FIELD_SELECTED
```
    Constant indicating the name of the selected attribute
    
    See Also:
    
    Constant Field Values
  - ANNOTATIONS
```
public static final String ANNOTATIONS
```
    Constant indicating the name of the Annotations node (JSON) that Boomi annotation resides in
    
    See Also:
    
    Constant Field Values
  - BOOMI_ANNOTATION_JSON_FIELDSPEC
```
public static final String BOOMI_ANNOTATION_JSON_FIELDSPEC
```
    Constant indicating the name of the Field Specification node (JSON)
    
    See Also:
    
    Constant Field Values
  - BOOMI_ANNOTATION_DATAFORMAT
```
public static final String BOOMI_ANNOTATION_DATAFORMAT
```
    Constant indicating the name of the Data Format element
    
    See Also:
    
    Constant Field Values
  - BOOMI_ANNOTATION_JSON_DATAFORMAT
```
public static final String BOOMI_ANNOTATION_JSON_DATAFORMAT
```
    Constant indicating the name of the Data Format node (JSON)
    
    See Also:
    
    Constant Field Values
  - BOOMI_ANNOTATION_JSON_FIELDS
```
public static final String BOOMI_ANNOTATION_JSON_FIELDS
```
    Constant indicating the name of the Fields node (JSON)
    
    See Also:
    
    Constant Field Values
  - BOOMI_ANNOTATION_DATATYPE
```
public static final String BOOMI_ANNOTATION_DATATYPE
```
    Constant indicating the name of the dataType attribute
    
    See Also:
    
    Constant Field Values
  - BOOMI_ANNOTATION_FORMAT
```
public static final String BOOMI_ANNOTATION_FORMAT
```
    Constant indicating the name of the format attribute
    
    See Also:
    
    Constant Field Values
  - BOOMI_FIELD_DELIMITER
```
public static final String BOOMI_FIELD_DELIMITER
```
    Constant indicating the delimiter in for field names
    
    See Also:
    
    Constant Field Values
  - OBJECT_TYPE_COMPARATOR
```
public static final Comparator<ObjectType> OBJECT_TYPE_COMPARATOR
```
    A Comparator which can be used to sort ObjectType's into lexicographical order. Uses the label for the ObjectType if defined, otherwise uses the id.
    Example usage:
```
 ObjectTypes types = new ObjectTypes();
 
 // ... populate types list ...
 
 Collections.sort(types.getTypes(), BrowseUtil.OBJECT_TYPE_COMPARATOR);
 
```
- Method Detail
  - buildFilterElement
```
public static Element buildFilterElement(Document doc,
                                         boolean ignore)
```
    Constructs a Filter element
    
    Parameters:
    
    doc - the Document used to construct the Element
    
    ignore - whether to ignore child elements or not
  - buildFilterElement
```
public static Element buildFilterElement(Document doc,
                                         boolean ignore,
                                         Collection<String> extraFilterFields)
```
    Constructs a Filter element
    
    Parameters:
    
    doc - the Document used to construct the Element
    
    ignore - whether to ignore child elements or not
    
    extraFilterFields - a Collection of Strings indicating additional filter field names that should be made available during browsing
  - generateFieldElement
```
public static Element generateFieldElement(Document doc,
                                           String name)
```
    Constructs a Field element
    
    Parameters:
    
    doc - the Document used to construct the Element
    
    name - the name of the filter field

Class BrowseUtil

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BOOMI_ANNOTATION_NAMESPACE

BOOMI_ANNOTATION_FILTER

BOOMI_ANNOTATION_FIELDSPEC

BOOMI_ANNOTATION_FILTER_IGNORE

BOOMI_ANNOTATION_IGNORE_FOR_FILTERS

BOOMI_ANNOTATION_IGNORE_FOR_SORT

BOOMI_ANNOTATION_IGNORE_FOR_SELECTION

BOOMI_ANNOTATION_FIELD

BOOMI_ANNOTATION_FIELD_NAME

BOOMI_ANNOTATION_FIELD_TYPE

BOOMI_ANNOTATION_FIELD_TYPE_NS

BOOMI_ANNOTATION_FIELD_FILTERABLE

BOOMI_ANNOTATION_FIELD_SORTABLE

BOOMI_ANNOTATION_FIELD_SELECTABLE

BOOMI_ANNOTATION_FIELD_SELECTED

ANNOTATIONS

BOOMI_ANNOTATION_JSON_FIELDSPEC

BOOMI_ANNOTATION_DATAFORMAT

BOOMI_ANNOTATION_JSON_DATAFORMAT

BOOMI_ANNOTATION_JSON_FIELDS

BOOMI_ANNOTATION_DATATYPE

BOOMI_ANNOTATION_FORMAT

BOOMI_FIELD_DELIMITER

OBJECT_TYPE_COMPARATOR

Method Detail

buildFilterElement

buildFilterElement

generateFieldElement