org.apache.directory.api.ldap.schema.converter

Class ObjectClassHolder

java.lang.Object

org.apache.directory.api.ldap.schema.converter.SchemaElementImpl

org.apache.directory.api.ldap.schema.converter.ObjectClassHolder

All Implemented Interfaces:

SchemaElement

public class ObjectClassHolder
extends SchemaElementImpl

A bean used to encapsulate the literal String values of an ObjectClass definition found within an OpenLDAP schema configuration file.

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.directory.api.ldap.model.schema.ObjectClassTypeEnum	classType The ObjectClass type
private List<String>	may The list of optional attributes
private List<String>	must The list of mandatory attributes
private List<String>	superiors The list of superiors

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

description, extensions, names, obsolete, oid

Constructor Summary

Constructors

Constructor and Description
ObjectClassHolder(String oid) Create an instance of ObjectClass element

Method Summary

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
org.apache.directory.api.ldap.model.schema.ObjectClassTypeEnum	getClassType()
List<String>	getMay()
List<String>	getMust()
List<String>	getSuperiors() Get the list of superior for this objectClass
void	setClassType(org.apache.directory.api.ldap.model.schema.ObjectClassTypeEnum classType) Set the objectClass type.
void	setMay(List<String> may) Set the list of optional attributes
void	setMust(List<String> must) Set the list of mandatory attributes
void	setSuperiors(List<String> superiors) Set the list of inherited objectClasses
String	toLdif(String schemaName) Convert this objectClass 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

superiors

private List<String> superiors

The list of superiors

must

private List<String> must

The list of mandatory attributes

may

private List<String> may

The list of optional attributes

classType

private org.apache.directory.api.ldap.model.schema.ObjectClassTypeEnum classType

The ObjectClass type

Constructor Detail

ObjectClassHolder

public ObjectClassHolder(String oid)

Create an instance of ObjectClass element

Parameters:

oid - the OjectClass OID

Method Detail

getSuperiors

public List<String> getSuperiors()

Get the list of superior for this objectClass

Returns:

A list of all inherited objectClasses

setSuperiors

public void setSuperiors(List<String> superiors)

Set the list of inherited objectClasses

Parameters:

superiors - The list of inherited objectClasses

getMust

public List<String> getMust()

Returns:

The list of mandatory attributes

setMust

public void setMust(List<String> must)

Set the list of mandatory attributes

Parameters:

must - The list of mandatory attributes

getMay

public List<String> getMay()

Returns:

The list of optional attributes

setMay

public void setMay(List<String> may)

Set the list of optional attributes

Parameters:

may - The list of optional attributes

getClassType

public org.apache.directory.api.ldap.model.schema.ObjectClassTypeEnum getClassType()

Returns:

The objectClass type

setClassType

public void setClassType(org.apache.directory.api.ldap.model.schema.ObjectClassTypeEnum classType)

Set the objectClass type.

Parameters:

classType - The objectClass type.

toLdif

public String toLdif(String schemaName)
              throws org.apache.directory.api.ldap.model.exception.LdapException

Convert this objectClass to a Ldif string

Parameters:

schemaName - The name of the schema file containing this objectClass

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 ObjectClass.

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