The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
# -*- perl -*-
# DO NOT EDIT - This file is generated by UMMF; http://ummf.sourceforge.net 
# From template: $Id: Perl.txt,v 1.77 2006/05/14 01:40:03 kstephens Exp $

package UMMF::UML_1_5::Behavioral_Elements::Common_Behavior::NodeInstance;

#use 5.6.1;
use strict;
use warnings;

#################################################################
# Version
#

our $VERSION = do { my @r = (q{1.5} =~ /\d+/g); sprintf "%d." . "%03d" x $#r, @r };


#################################################################
# Documentation
#

=head1 NAME

UMMF::UML_1_5::Behavioral_Elements::Common_Behavior::NodeInstance -- 

=head1 VERSION

1.5

=head1 SYNOPSIS

=head1 DESCRIPTION 

=head1 USAGE

=head1 EXPORT

=head1 METATYPE

L<UMMF::UML_1_5::Foundation::Core::Class|UMMF::UML_1_5::Foundation::Core::Class>

=head1 SUPERCLASSES

L<UMMF::UML_1_5::Behavioral_Elements::Common_Behavior::Instance|UMMF::UML_1_5::Behavioral_Elements::Common_Behavior::Instance>




=head1 ATTRIBUTES

I<NO ATTRIBUTES>


=head1 ASSOCIATIONS


=head2 C<nodeInstance> : I<THIS> C<0..1> E<lt>---E<gt>  C<resident> : UMMF::UML_1_5::Behavioral_Elements::Common_Behavior::ComponentInstance C<0..*>



=over 4

=item metatype = L<UMMF::UML_1_5::Foundation::Core::AssociationEnd|UMMF::UML_1_5::Foundation::Core::AssociationEnd>

=item type = L<UMMF::UML_1_5::Behavioral_Elements::Common_Behavior::ComponentInstance|UMMF::UML_1_5::Behavioral_Elements::Common_Behavior::ComponentInstance>

=item multiplicity = C<0..*>

=item changeability = C<changeable>

=item targetScope = C<instance>

=item ordering = C<>

=item isNavigable = C<1>

=item aggregation = C<none>

=item visibility = C<public>

=item container_type = C<Set::Object>

=back



=head1 METHODS

=cut



#################################################################
# Dependencies
#





use Carp qw(croak confess);
use Set::Object 1.05;
use Class::Multimethods 1.70;
use Data::Dumper;
use Scalar::Util qw(weaken);
use UMMF::UML_1_5::__ObjectBase qw(:__ummf_array);


#################################################################
# Generalizations
#

use base qw(
  UMMF::UML_1_5::Behavioral_Elements::Common_Behavior::Instance



);


#################################################################
# Exports
#

our @EXPORT_OK = qw(
);
our %EXPORT_TAGS = ( 'all' => \@EXPORT_OK );





#################################################################
# Validation
#


=head2 C<__validate_type>

  UMMF::UML_1_5::Behavioral_Elements::Common_Behavior::NodeInstance->__validate_type($value);

Returns true if C<$value> is a valid representation of L<UMMF::UML_1_5::Behavioral_Elements::Common_Behavior::NodeInstance|UMMF::UML_1_5::Behavioral_Elements::Common_Behavior::NodeInstance>.

=cut
sub __validate_type($$)
{
  my ($self, $x) = @_;

  no warnings;

  UNIVERSAL::isa($x, 'UMMF::UML_1_5::Behavioral_Elements::Common_Behavior::NodeInstance')  ;
}


=head2 C<__typecheck>

  UMMF::UML_1_5::Behavioral_Elements::Common_Behavior::NodeInstance->__typecheck($value, $msg);

Calls C<confess()> with C<$msg> if C<<UMMF::UML_1_5::Behavioral_Elements::Common_Behavior::NodeInstance->__validate_type($value)>> is false.

=cut
sub __typecheck
{
  my ($self, $x, $msg) = @_;

  confess("typecheck: $msg: type '" . 'UMMF::UML_1_5::Behavioral_Elements::Common_Behavior::NodeInstance' . ": value '$x'")
    unless __validate_type($self, $x);
}


=head2 C<isaNodeInstance>


Returns true if receiver is a L<UMMF::UML_1_5::Behavioral_Elements::Common_Behavior::NodeInstance|UMMF::UML_1_5::Behavioral_Elements::Common_Behavior::NodeInstance>.
Other receivers will return false.

=cut
sub isaNodeInstance { 1 }


=head2 C<isaBehavioral_Elements__Common_Behavior__NodeInstance>


Returns true if receiver is a L<UMMF::UML_1_5::Behavioral_Elements::Common_Behavior::NodeInstance|UMMF::UML_1_5::Behavioral_Elements::Common_Behavior::NodeInstance>.
Other receivers will return false.
This is the fully qualified version of the C<isaNodeInstance> method.

=cut
sub isaBehavioral_Elements__Common_Behavior__NodeInstance { 1 }


#################################################################
# Introspection
#

=head2 C<__model_name> 

  my $name = $obj_or_package->__model_name;

Returns the UML Model name (C<'Behavioral_Elements::Common_Behavior::NodeInstance'>) for an object or package of
this Classifier.

=cut
sub __model_name { 'Behavioral_Elements::Common_Behavior::NodeInstance' }



=head2 C<__isAbstract>

  $package->__isAbstract;

Returns C<0>.

=cut
sub __isAbstract { 0; }


my $__tangram_schema;
=head2 C<__tangram_schema>

  my $tangram_schema $obj_or_package->__tangram_schema

Returns a HASH ref that describes this Classifier for Tangram.

See L<UMMF::Export::Perl::Tangram|UMMF::Export::Perl::Tangram>

=cut
sub __tangram_schema
{
  my ($self) = @_;

  $__tangram_schema ||=
  {
   'classes' =>
   [
     'UMMF::UML_1_5::Behavioral_Elements::Common_Behavior::NodeInstance' =>
     {
       'table' => 'Behavioral_Elements__Common_Behavior__NodeInstance',
       'abstract' => 0,
       'slots' => 
       { 
	 # Attributes
	 
	 # Associations
	 	 	       'resident'
       => {
	 'type_impl' => 'iset',
         'class' => 'UMMF::UML_1_5::Behavioral_Elements::Common_Behavior::ComponentInstance',

                           'table' => 'Behavioral_Elements__Common_Behavior__NodeInstance__resident', 

                                                               'coll' => 'nodeInstance',

                                                                               }
      ,
                         },
       'bases' => [  'UMMF::UML_1_5::Behavioral_Elements::Common_Behavior::Instance',  ],
       'sql' => {

       },
     },
   ],

   'sql' =>
   {
    # Note Tangram::Ref::get_exporter() has
    # "UPDATE $table SET $self->{col} = $refid WHERE id = $id",
    # The id_col is hard-coded, 
    # Thus id_col will not work.
    #'id_col' => '__sid',
    #'class_col' => '__stype',
   },
     # 'set_id' => sub { }
     # 'get_id' => sub { }

      
  };
}


#################################################################
# Class Attributes
#


    

#################################################################
# Class Associations
#


    

#################################################################
# Initialization
#


=head2 C<___initialize>

Initialize all Attributes and AssociationEnds in a instance of this Classifier.
Does B<not> initalize slots in its Generalizations.

See also: C<__initialize>.

=cut
sub ___initialize
{
  my ($self) = @_;

  # Attributes



  # Associations

  # AssociationEnd 
  #  nodeInstance 0..1
  #  <--> 
  #  resident 0..* UMMF::UML_1_5::Behavioral_Elements::Common_Behavior::ComponentInstance.
    if ( defined $self->{'resident'} ) {
    my $x = $self->{'resident'};
        $self->{'resident'} = Set::Object->new();
        $self->set_resident(@$x);
  }
  

  $self;
}


my $__initialize_use;

=head2 C<__initialize>

Initialize all slots in this Classifier and all its Generalizations.

See also: C<___initialize>.

=cut
sub __initialize
{
  my ($self) = @_;

  # $DB::single = 1;

  unless ( ! $__initialize_use ) {
    $__initialize_use = 1;
    $self->__use('UMMF::UML_1_5::Foundation::Core::Element');
    $self->__use('UMMF::UML_1_5::Foundation::Core::ModelElement');
    $self->__use('UMMF::UML_1_5::Behavioral_Elements::Common_Behavior::Instance');
  }

  $self->UMMF::UML_1_5::Behavioral_Elements::Common_Behavior::NodeInstance::___initialize;
  $self->UMMF::UML_1_5::Foundation::Core::Element::___initialize;
  $self->UMMF::UML_1_5::Foundation::Core::ModelElement::___initialize;
  $self->UMMF::UML_1_5::Behavioral_Elements::Common_Behavior::Instance::___initialize;

  $self;
}
      

=head2 C<__create>

Calls all <<create>> Methods for this Classifier and all Generalizations.

See also: C<___create>.

=cut
sub __create
{
  my ($self, @args) = @_;

  # $DB::single = 1;
  $self->UMMF::UML_1_5::Behavioral_Elements::Common_Behavior::NodeInstance::___create(@args);
  $self->UMMF::UML_1_5::Foundation::Core::Element::___create();
  $self->UMMF::UML_1_5::Foundation::Core::ModelElement::___create();
  $self->UMMF::UML_1_5::Behavioral_Elements::Common_Behavior::Instance::___create();

  $self;
}




#################################################################
# Attributes
#




#################################################################
# Association
#


=for html <hr/>

=cut

#################################################################
# AssociationEnd nodeInstance <---> resident
# type = UMMF::UML_1_5::Behavioral_Elements::Common_Behavior::ComponentInstance
# multiplicity = 0..*
# ordering = 

=head2 C<resident>

  my @val = $obj->resident;
  my $ary_val = $obj->resident;

Returns the AssociationEnd C<resident> values of type L<UMMF::UML_1_5::Behavioral_Elements::Common_Behavior::ComponentInstance|UMMF::UML_1_5::Behavioral_Elements::Common_Behavior::ComponentInstance>.
In array context, returns all the objects in the Association.
In scalar context, returns an array ref of all the objects in the Association.

=cut
sub resident ($)
{
  my ($self) = @_;

    my $x = $self->{'resident'};

  # confess("Container for resident $x is not a blessed ref: " . Data::Dumper->new([ $self ], [qw($self)])->Maxdepth(2)->Dump()) if $x && ref($x) !~ /::/;
 
  wantarray ? ($x ? $x->members() : ()) : [ $x ? $x->members() : () ];
  
}


=head2 C<set_resident>

  $obj->set_resident(@val);

Sets the AssociationEnd C<resident> value.
Elements of C<@val> must of type L<UMMF::UML_1_5::Behavioral_Elements::Common_Behavior::ComponentInstance|UMMF::UML_1_5::Behavioral_Elements::Common_Behavior::ComponentInstance>.
Returns C<$obj>.

=cut
sub set_resident ($@)
{
  my ($self, @val) = @_;
  
  $self->clear_resident;
  $self->add_resident(@val);
}


=head2 C<add_resident>

  $obj->add_resident(@val);

Adds AssociationEnd C<resident> values.
Elements of C<@val> must of type L<UMMF::UML_1_5::Behavioral_Elements::Common_Behavior::ComponentInstance|UMMF::UML_1_5::Behavioral_Elements::Common_Behavior::ComponentInstance>.
Returns C<$obj>.

=cut
sub add_resident ($@)
{
  my ($self, @val) = @_;
  
    my $x = $self->{'resident'} ||= Set::Object->new();
    my $old; # Place holder for other MACRO.
  
  for my $val ( @val ) {
    # Recursion lock
        next if $x->includes($val);
        $self->__use('UMMF::UML_1_5::Behavioral_Elements::Common_Behavior::ComponentInstance')->__typecheck($val, "UMMF::UML_1_5::Behavioral_Elements::Common_Behavior::NodeInstance.resident");

    # Recursion lock
        $x->insert($val);
    # weaken?
    
    # Remove and add associations with other ends.
        
    $old->remove_nodeInstance($self) if $old;
    $val->add_nodeInstance($self)    if $val;

    }
  
  $self;
}


=head2 C<remove_resident>

  $obj->remove_resident(@val);

Removes the AssociationEnd C<resident> values C<@val>.
Elements of C<@val> must of type L<UMMF::UML_1_5::Behavioral_Elements::Common_Behavior::ComponentInstance|UMMF::UML_1_5::Behavioral_Elements::Common_Behavior::ComponentInstance>.
Returns C<$obj>.

=cut
sub remove_resident ($@)
{
  my ($self, @val) = @_;
  
    my $x = $self->{'resident'} ||= Set::Object->new();
  
  for my $old ( @val ) {
    # Recursion lock
        next unless $x->includes($old);
    
    my $val = $old;
      
    $self->__use('UMMF::UML_1_5::Behavioral_Elements::Common_Behavior::ComponentInstance')->__typecheck($val, "UMMF::UML_1_5::Behavioral_Elements::Common_Behavior::NodeInstance.resident");

    # Recursion lock
        $x->remove($old);
    
    $val = undef;

    # Remove associations with other ends.

        
    $old->remove_nodeInstance($self) if $old;
    $val->add_nodeInstance($self)    if $val;

  ;

  }
  
  $self;
}


=head2 C<clear_resident>

  $obj->clear_resident;

Clears the AssociationEnd C<resident> links to L<UMMF::UML_1_5::Behavioral_Elements::Common_Behavior::ComponentInstance|UMMF::UML_1_5::Behavioral_Elements::Common_Behavior::ComponentInstance>.
Returns C<$obj>.

=cut
sub clear_resident ($) 
{
  my ($self) = @_;
  
    my $x = $self->{'resident'} ||= Set::Object->new();
  
  my $val; # Place holder for other MACRO.
  
    $self->{'resident'} = Set::Object->new(); # Recursion lock
  for my $old ( $x->members() ) {     # Recursion lock
  
    # Remove associations with other ends.

        
    $old->remove_nodeInstance($self) if $old;
    $val->add_nodeInstance($self)    if $val;

  ;

  }
  
  $self;
}


=head2 C<count_resident>

  $obj->count_resident;

Returns the number of elements associated with C<resident>.

=cut
sub count_resident ($)
{
  my ($self) = @_;

  my $x = $self->{'resident'};

    defined $x ? $x->size : 0;
  }







# End of Class NodeInstance


=pod

=for html <hr/>

I<END OF DOCUMENT>

=cut

############################################################################

1; # is true!

############################################################################

### Keep these comments at end of file: kstephens@users.sourceforge.net 2003/04/06 ###
### Local Variables: ###
### mode:perl ###
### perl-indent-level:2 ###
### perl-continued-statement-offset:0 ###
### perl-brace-offset:0 ###
### perl-label-offset:0 ###
### End: ###