DirRecord (bw-util-directory 4.0.3 API)

java.lang.Object
- org.bedework.util.directory.common.DirRecord

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

BasicDirRecord
```
public abstract class DirRecord
extends Object
implements Serializable
```
This class represents a directory record which may be built from a number of attributes, retrieved as a search result or read from some input stream.
We will implement some aspects of the ldif as defined in RFC 2849 within this class. These will be related to the content vs change records. By default, a DirRecord object will be a content record. However, we will allow the creation of change type records. Having this defined here allows applications to pass around DirRecord objects without any idea of the underlying implementation.
Currently the following is implemented:
- content records Consist of a dn with an associated set of attributes with values. No attribute options are implemented. Encoded strings may be converted incorrectly (need to check locale specifics)
- change records.
  - add: Implemented. Look just like content records.
  - delete: Implemented. Consist of a dn only.
  - all others are unimplemented.
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`changeTypeAdd`
`static int`	`changeTypeDelete`
`static int`	`changeTypeInvalid`
`static int`	`changeTypeModdn`
`static int`	`changeTypeModify`

Constructor Summary

Constructors
Constructor and Description

DirRecord()

Constructors
Constructor and Description
`DirRecord()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAttr(String attr, Object val)` Add the attribute value to the table.
`NamingEnumeration`	`attrElements(String attr)` Retrieve an enumeration of the named attribute's values.
`boolean`	`attrEquals(Attribute thisA, Attribute that)`
`int`	`attrValCompare(Object val, Attribute that, boolean ignoreCase)` Compare the given single value with the attribute value(s).
`int`	`attrValCompare(Object val, String attrName, boolean ignoreCase)` Extract the target attribute from this record then compare the given single value with the attribute value(s).
`void`	`clear()` Should be overriden to clear attributes.
`boolean`	`contains(Attribute attr)` Return true if the record contains all of the values of the given attribute.
`boolean`	`dnEquals(DirRecord that)` Check dns for equality
`boolean`	`equals(DirRecord that)` Compare this with that.
`boolean`	`equals(DirRecord that, String[] attrIDs)` Simpler form of equals in which attributes have the same names in both records.
`boolean`	`equals(DirRecord that, String[] thisAttrIDs, String[] thatAttrIDs)` Compare this with that only looking at the named attributes.
`boolean`	`equalsAllBut(DirRecord that, String[] attrIDs)` This compares all but the named attributes allbut true => All must be equal except those on the list
`Attribute`	`findAttr(String attr)` Find the attribute for this record with the given name.
`abstract Attributes`	`getAttributes()`
`String`	`getAttrStr(String attr)` getAttrStr - return first (or only) string value for given attribute
`Object`	`getAttrVal(String attr)` getAttrVal - return first (or only) value for given attribute "dn" is treated as an attribute name.
`int`	`getChangeType()`
`String`	`getDn()` return the dn for this record.
`boolean`	`getIsContent()`
`ModificationItem[]`	`getMods()`
`void`	`setAttr(String attr, Object val)` Set the attribute value in the table.
`void`	`setChangeType(int val)`
`void`	`setDn(String dn)` Set the dn for this record.
`void`	`setIsContent(boolean val)`

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

- Field Detail
  - changeTypeInvalid
```
public static final int changeTypeInvalid
```
    See Also:
    
    Constant Field Values
  - changeTypeAdd
```
public static final int changeTypeAdd
```
    See Also:
    
    Constant Field Values
  - changeTypeDelete
```
public static final int changeTypeDelete
```
    See Also:
    
    Constant Field Values
  - changeTypeModify
```
public static final int changeTypeModify
```
    See Also:
    
    Constant Field Values
  - changeTypeModdn
```
public static final int changeTypeModdn
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DirRecord
```
public DirRecord()
```
- Method Detail
  - getAttributes
```
public abstract Attributes getAttributes()
                                  throws NamingException
```
    Throws:
    
    NamingException
  - findAttr
```
public Attribute findAttr(String attr)
                   throws NamingException
```
    Find the attribute for this record with the given name. Return null if not defind.
    
    Throws:
    
    NamingException
  - setAttr
```
public void setAttr(String attr,
                    Object val)
             throws NamingException
```
    Set the attribute value in the table. Replaces any existing value(s) This does not write back to the directory
    
    Throws:
    
    NamingException
  - clear
```
public void clear()
```
    Should be overriden to clear attributes.
  - getDn
```
public String getDn()
             throws Exception
```
    return the dn for this record.
    
    Throws:
    
    Exception
  - setDn
```
public void setDn(String dn)
           throws NamingException
```
    Set the dn for this record.
    
    Throws:
    
    NamingException
  - equals
```
public boolean equals(DirRecord that)
               throws Exception
```
    Compare this with that. Return true if they are equal.
    
    Throws:
    
    Exception
  - equals
```
public boolean equals(DirRecord that,
                      String[] thisAttrIDs,
                      String[] thatAttrIDs)
               throws Exception
```
    Compare this with that only looking at the named attributes. For this method, the dns must be equal and the values of the named attributes must be equal but their names may differ. The two arrays of attrIDs must be non-null and of the same length or an exception is raised. If there are no attributes in both records they are considered equal. If there are no attributes in only one record they are unequal. Zero length attrID lists means only the dn is compared.
    
    Throws:
    
    Exception
  - equals
```
public boolean equals(DirRecord that,
                      String[] attrIDs)
               throws Exception
```
    Simpler form of equals in which attributes have the same names in both records.
    
    Throws:
    
    Exception
  - equalsAllBut
```
public boolean equalsAllBut(DirRecord that,
                            String[] attrIDs)
                     throws Exception
```
    This compares all but the named attributes allbut true => All must be equal except those on the list
    
    Throws:
    
    Exception
  - attrEquals
```
public boolean attrEquals(Attribute thisA,
                          Attribute that)
                   throws Exception
```
    Throws:
    
    Exception
  - attrValCompare
```
public int attrValCompare(Object val,
                          Attribute that,
                          boolean ignoreCase)
                   throws Exception
```
    Compare the given single value with the attribute value(s).
    
    Returns:
    
    -2 for not equal or not present in multi-valued attribute -1 for val < that 0 for val = that 1 for val > that 2 for val present in multi-valued attr
    
    Throws:
    
    Exception
  - attrValCompare
```
public int attrValCompare(Object val,
                          String attrName,
                          boolean ignoreCase)
                   throws Exception
```
    Extract the target attribute from this record then compare the given single value with the attribute value(s).
    
    Returns:
    
    -2 for not equal or not present in multi-valued attribute -1 for val < that 0 for val = that 1 for val > that 2 for val present in multi-valued attr
    
    Throws:
    
    Exception
  - dnEquals
```
public boolean dnEquals(DirRecord that)
                 throws Exception
```
    Check dns for equality
    
    Throws:
    
    Exception
  - addAttr
```
public void addAttr(String attr,
                    Object val)
             throws NamingException
```
    Add the attribute value to the table. If an attribute already exists add it to the end of its values.
    
    Parameters:
    
    attr - String attribute name
    
    val - Object value
    
    Throws:
    
    NamingException
  - getAttrVal
```
public Object getAttrVal(String attr)
                  throws Exception
```
    getAttrVal - return first (or only) value for given attribute "dn" is treated as an attribute name.
    
    Parameters:
    
    attr - String attribute name
    
    Returns:
    
    Object attribute value
    
    Throws:
    
    Exception
  - contains
```
public boolean contains(Attribute attr)
                 throws Exception
```
    Return true if the record contains all of the values of the given attribute.
    
    Parameters:
    
    attr - Attribute we're looking for
    
    Returns:
    
    boolean true if we found it
    
    Throws:
    
    Exception
  - attrElements
```
public NamingEnumeration attrElements(String attr)
                               throws NamingException
```
    Retrieve an enumeration of the named attribute's values. The behaviour of this enumeration is unspecified if the the attribute's values are added, changed, or removed while the enumeration is in progress. If the attribute values are ordered, the enumeration's items will be ordered.
    
    Returns:
    
    A non-null enumeration of the attribute's values. Each element of the enumeration is a possibly null Object. The object's class is the class of the attribute value. The element is null if the attribute's value is null. If the attribute has zero values, an empty enumeration is returned.
    
    Throws:
    
    NamingException - If a naming exception was encountered while retrieving the values.
  - getAttrStr
```
public String getAttrStr(String attr)
                  throws Exception
```
    getAttrStr - return first (or only) string value for given attribute
    
    Parameters:
    
    attr - String attribute name
    
    Returns:
    
    String attribute value
    
    Throws:
    
    Exception
  - getIsContent
```
public boolean getIsContent()
```
  - getChangeType
```
public int getChangeType()
```
  - getMods
```
public ModificationItem[] getMods()
                           throws Exception
```
    Throws:
    
    Exception
  - setIsContent
```
public void setIsContent(boolean val)
```
  - setChangeType
```
public void setChangeType(int val)
```

Class DirRecord

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

changeTypeInvalid

changeTypeAdd

changeTypeDelete

changeTypeModify

changeTypeModdn

Constructor Detail

DirRecord

Method Detail

getAttributes

findAttr

setAttr

clear

getDn

setDn

equals

equals

equals

equalsAllBut

attrEquals

attrValCompare

attrValCompare

dnEquals

addAttr

getAttrVal

contains

attrElements

getAttrStr

getIsContent

getChangeType

getMods

setIsContent

setChangeType