AttributeTypeHolder (Apache Directory LDAP API Schema Converter 2.0.0.AM4 API)

java.lang.Object
- org.apache.directory.api.ldap.schema.converter.SchemaElementImpl
- - org.apache.directory.api.ldap.schema.converter.AttributeTypeHolder

All Implemented Interfaces:

SchemaElement
```
public class AttributeTypeHolder
extends SchemaElementImpl
```
A bean used to hold the literal values of an AttributeType parsed out of an OpenLDAP schema configuration file.

Author:

Apache Directory Project

Field Summary

Fields
Modifier and Type	Field and Description
`private boolean`	`collective` A flag for collective attribute.
`private String`	`equality` The equality matching rule
`private boolean`	`noUserModification` A flaf for immutable attribue.
`private long`	`oidLen` The optional length for this attribute
`private String`	`ordering` The ordering matching rule
`private boolean`	`singleValue` A flag for single valued attributes.
`private String`	`substr` The substring matching rule
`private String`	`superior` The optional superior
`private String`	`syntax` The syntax this attribute respects
`private org.apache.directory.api.ldap.model.schema.UsageEnum`	`usage` The attribute uase.

Fields inherited from class org.apache.directory.api.ldap.schema.converter.SchemaElementImpl
description, extensions, names, obsolete, oid

Constructor Summary

Constructors
Constructor and Description

AttributeTypeHolder(String oid)
Create an instance of an attributeType

Constructors
Constructor and Description
`AttributeTypeHolder(String oid)` Create an instance of an attributeType

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`dnToLdif(String schemaName)` Transform a schema name to a Dn pointing to the correct position in the DIT
`String`	`getEquality()` Get the equality Matching Rule
`long`	`getOidLen()` Get the attributeType's syntax length
`String`	`getOrdering()` Get the ordering Matching Rule
`String`	`getSubstr()` Get the substring Matching Rule
`String`	`getSuperior()` Get the optional attributeType's superior
`String`	`getSyntax()` Get the attributeType's syntax
`org.apache.directory.api.ldap.model.schema.UsageEnum`	`getUsage()` Get the attributeType's usage
`boolean`	`isCollective()` Tells if the attributeType is collectove or not
`boolean`	`isNoUserModification()` Tells if the attributeType is mutable or not
`boolean`	`isSingleValue()` Tells if the attribute is single-valued
`void`	`setCollective(boolean collective)` Set the attributeType collective flag
`void`	`setEquality(String equality)` Set the equality Matching Rule
`void`	`setNoUserModification(boolean noUserModification)` Set the attributeType noUserModification flag
`void`	`setOidLen(long oidLen)` Set the attributeType's syntax length
`void`	`setOrdering(String ordering)` Set the ordering Matching Rule
`void`	`setSingleValue(boolean singleValue)` Set the attributeType singleValue flag
`void`	`setSubstr(String substr)` Set the substring Matching Rule
`void`	`setSuperior(String superior)` Set the attributeType's superior
`void`	`setSyntax(String syntax)` Set the attributeType's syntax
`void`	`setUsage(org.apache.directory.api.ldap.model.schema.UsageEnum usage)` Set the attributeType's usage
`String`	`toLdif(String schemaName)` Convert this attributeType to a Ldif string
`String`	`toString()`

Methods inherited from class org.apache.directory.api.ldap.schema.converter.SchemaElementImpl
extensionsToLdif, getDescription, getExtension, getExtensions, getNames, getOid, isObsolete, schemaToLdif, setDescription, setExtensions, setNames, setObsolete

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

- Field Detail
  - singleValue
```
private boolean singleValue
```
    A flag for single valued attributes. Default to false
  - collective
```
private boolean collective
```
    A flag for collective attribute. Default to false
  - noUserModification
```
private boolean noUserModification
```
    A flaf for immutable attribue. Default to false
  - superior
```
private String superior
```
    The optional superior
  - equality
```
private String equality
```
    The equality matching rule
  - ordering
```
private String ordering
```
    The ordering matching rule
  - substr
```
private String substr
```
    The substring matching rule
  - syntax
```
private String syntax
```
    The syntax this attribute respects
  - oidLen
```
private long oidLen
```
    The optional length for this attribute
  - usage
```
private org.apache.directory.api.ldap.model.schema.UsageEnum usage
```
    The attribute uase. Default to userApplication
- Constructor Detail
  - AttributeTypeHolder
```
public AttributeTypeHolder(String oid)
```
    Create an instance of an attributeType
    
    Parameters:
    
    oid - The attributeType's OID
- Method Detail
  - isSingleValue
```
public boolean isSingleValue()
```
    Tells if the attribute is single-valued
    
    Returns:
    
    true if the attribute is single-valued, false otherwise
  - setSingleValue
```
public void setSingleValue(boolean singleValue)
```
    Set the attributeType singleValue flag
    
    Parameters:
    
    singleValue - The value for this flag
  - isCollective
```
public boolean isCollective()
```
    Tells if the attributeType is collectove or not
    
    Returns:
    
    True if the attributeType is collective, false otherwise
  - setCollective
```
public void setCollective(boolean collective)
```
    Set the attributeType collective flag
    
    Parameters:
    
    collective - The value for this flag
  - isNoUserModification
```
public boolean isNoUserModification()
```
    Tells if the attributeType is mutable or not
    
    Returns:
    
    True if the attributeType is immutable, false otherwise
  - setNoUserModification
```
public void setNoUserModification(boolean noUserModification)
```
    Set the attributeType noUserModification flag
    
    Parameters:
    
    noUserModification - The value for this flag
  - getSuperior
```
public String getSuperior()
```
    Get the optional attributeType's superior
    
    Returns:
    
    The attributeType's superior, if any
  - setSuperior
```
public void setSuperior(String superior)
```
    Set the attributeType's superior
    
    Parameters:
    
    superior - The attributeType's superior
  - getEquality
```
public String getEquality()
```
    Get the equality Matching Rule
    
    Returns:
    
    The equality matchingRule
  - setEquality
```
public void setEquality(String equality)
```
    Set the equality Matching Rule
    
    Parameters:
    
    equality - The equality Matching Rule
  - getOrdering
```
public String getOrdering()
```
    Get the ordering Matching Rule
    
    Returns:
    
    The ordering matchingRule
  - setOrdering
```
public void setOrdering(String ordering)
```
    Set the ordering Matching Rule
    
    Parameters:
    
    ordering - The ordering Matching Rule
  - getSubstr
```
public String getSubstr()
```
    Get the substring Matching Rule
    
    Returns:
    
    The substring matchingRule
  - setSubstr
```
public void setSubstr(String substr)
```
    Set the substring Matching Rule
    
    Parameters:
    
    substr - The substring Matching Rule
  - getSyntax
```
public String getSyntax()
```
    Get the attributeType's syntax
    
    Returns:
    
    The attributeType's syntax
  - setSyntax
```
public void setSyntax(String syntax)
```
    Set the attributeType's syntax
    
    Parameters:
    
    syntax - The attributeType's syntax
  - getUsage
```
public org.apache.directory.api.ldap.model.schema.UsageEnum getUsage()
```
    Get the attributeType's usage
    
    Returns:
    
    The attributeType's usage
  - setUsage
```
public void setUsage(org.apache.directory.api.ldap.model.schema.UsageEnum usage)
```
    Set the attributeType's usage
    
    Parameters:
    
    usage - The attributeType's usage
  - getOidLen
```
public long getOidLen()
```
    Get the attributeType's syntax length
    
    Returns:
    
    The attributeType's syntax length
  - setOidLen
```
public void setOidLen(long oidLen)
```
    Set the attributeType's syntax length
    
    Parameters:
    
    oidLen - The attributeType's syntax length
  - toLdif
```
public String toLdif(String schemaName)
              throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Convert this attributeType to a Ldif string
    
    Parameters:
    
    schemaName - The name of the schema file containing this attributeType
    
    Returns:
    
    A ldif formatted string
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - If something went wrong
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a String representing this AttributeType.
  - dnToLdif
```
public String dnToLdif(String schemaName)
                throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Transform a schema name to a Dn pointing to the correct position in the DIT
    
    Specified by:
    
    dnToLdif in class SchemaElementImpl
    
    Parameters:
    
    schemaName - The schema name
    
    Returns:
    
    the Dn associated with this schema in the DIT
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - If the conversion goes wrong

Class AttributeTypeHolder

Field Summary

Fields inherited from class org.apache.directory.api.ldap.schema.converter.SchemaElementImpl

Constructor Summary

Method Summary

Methods inherited from class org.apache.directory.api.ldap.schema.converter.SchemaElementImpl

Methods inherited from class java.lang.Object

Field Detail

singleValue

collective

noUserModification

superior

equality

ordering

substr

syntax

oidLen

usage

Constructor Detail

AttributeTypeHolder

Method Detail

isSingleValue

setSingleValue

isCollective

setCollective

isNoUserModification

setNoUserModification

getSuperior

setSuperior

getEquality

setEquality

getOrdering

setOrdering

getSubstr

setSubstr

getSyntax

setSyntax

getUsage

setUsage

getOidLen

setOidLen

toLdif

toString

dnToLdif