Class: Treequel::Schema::MatchingRuleUse

Inherits:

Object

Object
Treequel::Schema::MatchingRuleUse

show all

Extended by:: Loggability, AttributeDeclarations

Includes:: Constants::Patterns

Defined in:: lib/treequel/schema/matchingruleuse.rb

Overview

This is a class for representing matchingRuleUse declarations in a Treequel::Schema.

Constant Summary

Constants included from Constants::Patterns

Instance Attribute Summary collapse

#attr_oids ⇒ Object readonly

The OIDs of the attributes the matchingRuleUse applies to.
#desc ⇒ Object

The matchingRuleUse’s description.
#extensions ⇒ Object

The matchingRuleUse’s extensions (as a String).
#names ⇒ Object readonly

The Array of the matchingRuleUse’s names.
#oid ⇒ Object readonly

The matchingRuleUse’s oid.
#schema ⇒ Object readonly

The schema the matchingRuleUse belongs to.

Class Method Summary collapse

.parse(schema, description) ⇒ Object

Parse an MatchingRuleUse entry from a matchingRuleUse description from a schema.

Instance Method Summary collapse

#attribute_types ⇒ Object

Return Treequel::Schema::AttributeType objects for each of the types this MatchingRuleUse applies to.
#initialize(schema, oid, attr_oids, names = nil, desc = nil, obsolete = false, extensions = nil) ⇒ MatchingRuleUse constructor

Create a new MatchingRuleUse.
#inspect ⇒ Object

Return a human-readable representation of the object suitable for debugging.
#name ⇒ Object

Return the first of the matchingRuleUse’s names, if it has any, or nil.
#to_s ⇒ Object

Returns the matchingRuleUse as a String, which is the RFC4512-style schema description.

Methods included from AttributeDeclarations

predicate_attr

Constructor Details

#initialize(schema, oid, attr_oids, names = nil, desc = nil, obsolete = false, extensions = nil) ⇒ `MatchingRuleUse`

Create a new MatchingRuleUse

# File 'lib/treequel/schema/matchingruleuse.rb', line 51

def initialize( schema, oid, attr_oids, names=nil, desc=nil, obsolete=false, extensions=nil )
	@schema     = schema

	@oid        = oid
	@names      = names
	@desc       = desc
	@obsolete   = obsolete ? true : false
	@attr_oids  = attr_oids

	@extensions = extensions

	super()
end

Instance Attribute Details

#attr_oids ⇒ `Object` (readonly)

The OIDs of the attributes the matchingRuleUse applies to



86
87
88

# File 'lib/treequel/schema/matchingruleuse.rb', line 86

def attr_oids
  @attr_oids
end

#desc ⇒ `Object`

The matchingRuleUse’s description



80
81
82

# File 'lib/treequel/schema/matchingruleuse.rb', line 80

def desc
  @desc
end

#extensions ⇒ `Object`

The matchingRuleUse’s extensions (as a String)



89
90
91

# File 'lib/treequel/schema/matchingruleuse.rb', line 89

def extensions
  @extensions
end

#names ⇒ `Object` (readonly)

The Array of the matchingRuleUse’s names



77
78
79

# File 'lib/treequel/schema/matchingruleuse.rb', line 77

def names
  @names
end

#oid ⇒ `Object` (readonly)

The matchingRuleUse’s oid



74
75
76

# File 'lib/treequel/schema/matchingruleuse.rb', line 74

def oid
  @oid
end

#schema ⇒ `Object` (readonly)

The schema the matchingRuleUse belongs to



71
72
73

# File 'lib/treequel/schema/matchingruleuse.rb', line 71

def schema
  @schema
end

Class Method Details

.parse(schema, description) ⇒ `Object`

Parse an MatchingRuleUse entry from a matchingRuleUse description from a schema.

# File 'lib/treequel/schema/matchingruleuse.rb', line 29

def self::parse( schema, description )
	unless match = ( LDAP_MATCHING_RULE_USE_DESCRIPTION.match(description) )
		raise Treequel::ParseError, "failed to parse matchingRuleUse from %p" % [ description ]
	end

	oid, names, desc, obsolete, attr_oids, extensions = match.captures
	# Treequel.logger.debug "  parsed matchingRuleUse: %p" % [ match.captures ]

	# Normalize the attributes
	names     = Treequel::Schema.parse_names( names )
	desc      = Treequel::Schema.unquote_desc( desc )
	attr_oids = Treequel::Schema.parse_oids( attr_oids )

	return self.new( schema, oid, attr_oids, names, desc, obsolete, extensions )
end

Instance Method Details

#attribute_types ⇒ `Object`

Return Treequel::Schema::AttributeType objects for each of the types this MatchingRuleUse applies to.



137
138
139

# File 'lib/treequel/schema/matchingruleuse.rb', line 137

def attribute_types
	return self.attr_oids.collect {|oid| self.schema.attribute_types[oid] }
end

#inspect ⇒ `Object`

Return a human-readable representation of the object suitable for debugging

# File 'lib/treequel/schema/matchingruleuse.rb', line 123

def inspect
	return "#<%s:0x%0x %s(%s) %p -> %p >" % [
		self.class.name,
		self.object_id / 2,
		self.name,
		self.oid,
		self.desc,
		self.attr_oids,
	]
end

#name ⇒ `Object`

Return the first of the matchingRuleUse’s names, if it has any, or nil.



93
94
95

# File 'lib/treequel/schema/matchingruleuse.rb', line 93

def name
	return self.names.first
end

#to_s ⇒ `Object`

Returns the matchingRuleUse as a String, which is the RFC4512-style schema description.

# File 'lib/treequel/schema/matchingruleuse.rb', line 108

def to_s
	parts = [ self.oid ]

	parts << "NAME %s" % Treequel::Schema.qdescrs( self.names ) unless self.names.empty?

	parts << "DESC '%s'" % [ self.desc ]           if self.desc
	parts << "OBSOLETE"                            if self.obsolete?
	parts << "APPLIES %s" % [ Treequel::Schema.oids(self.attr_oids) ]
	parts << self.extensions.strip             unless self.extensions.empty?

	return "( %s )" % [ parts.join(' ') ]
end

Class: Treequel::Schema::MatchingRuleUse

Overview

Constant Summary

Constants included from Constants::Patterns

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from AttributeDeclarations

Constructor Details

#initialize(schema, oid, attr_oids, names = nil, desc = nil, obsolete = false, extensions = nil) ⇒ MatchingRuleUse

Instance Attribute Details

#attr_oids ⇒ Object (readonly)

#desc ⇒ Object

#extensions ⇒ Object

#names ⇒ Object (readonly)

#oid ⇒ Object (readonly)

#schema ⇒ Object (readonly)