UMMF::UML_1_5::Foundation::Core::Enumeration - UMMF::UML_1_5::Foundation::Core::Enumeration documentation

UMMF documentation Contained in the UMMF distribution.

Index

Code Index:

NAME

Top

UMMF::UML_1_5::Foundation::Core::Enumeration --

VERSION

Top

1.5

SYNOPSIS

Top

DESCRIPTION

Top

USAGE

Top

EXPORT

Top

METATYPE

Top

UMMF::UML_1_5::Foundation::Core::Class

SUPERCLASSES

Top

UMMF::UML_1_5::Foundation::Core::DataType

ATTRIBUTES

Top

NO ATTRIBUTES

ASSOCIATIONS

Top

enumeration : THIS 1 <---> literal : UMMF::UML_1_5::Foundation::Core::EnumerationLiteral 1..*

metatype = UMMF::UML_1_5::Foundation::Core::AssociationEnd
type = UMMF::UML_1_5::Foundation::Core::EnumerationLiteral
multiplicity = 1..*
changeability = changeable
targetScope = instance
ordering = ordered
isNavigable = 1
aggregation = none
visibility = public
container_type = ARRAY

METHODS

Top

__validate_type

  UMMF::UML_1_5::Foundation::Core::Enumeration->__validate_type($value);

Returns true if $value is a valid representation of UMMF::UML_1_5::Foundation::Core::Enumeration.

__typecheck

  UMMF::UML_1_5::Foundation::Core::Enumeration->__typecheck($value, $msg);

Calls confess() with $msg if <UMMF::UML_1_5::Foundation::Core::Enumeration-__validate_type($value)>> is false.

isaEnumeration

Returns true if receiver is a UMMF::UML_1_5::Foundation::Core::Enumeration. Other receivers will return false.

isaFoundation__Core__Enumeration

Returns true if receiver is a UMMF::UML_1_5::Foundation::Core::Enumeration. Other receivers will return false. This is the fully qualified version of the isaEnumeration method.

__model_name 

  my $name = $obj_or_package->__model_name;

Returns the UML Model name ('Foundation::Core::Enumeration') for an object or package of this Classifier.

__isAbstract

  $package->__isAbstract;

Returns 0.

__tangram_schema

  my $tangram_schema $obj_or_package->__tangram_schema

Returns a HASH ref that describes this Classifier for Tangram.

See UMMF::Export::Perl::Tangram

___initialize

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

See also: __initialize.

__initialize

Initialize all slots in this Classifier and all its Generalizations.

See also: ___initialize.

__create

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

See also: ___create.

literal

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

Returns the AssociationEnd literal values of type UMMF::UML_1_5::Foundation::Core::EnumerationLiteral. In array context, returns all the objects in the Association. In scalar context, returns an array ref of all the objects in the Association.

index_literal

  my $x = $obj->index_literal($i);
  my @x = $obj->index_literal($i, $count);

In scalar context, returns the value of AssociationEnd literal at index $i. In array context, returns the values between index $i and $i + $count - 1, inclusive.

index_of_literal

  my $index = $obj->index_of_literal($val);

Returns the index of $val in AssociationEnd literal. Return undef if $val is not in literal.

set_literal

  $obj->set_literal(@val);

Sets the AssociationEnd literal value. Elements of @val must of type UMMF::UML_1_5::Foundation::Core::EnumerationLiteral. Returns $obj.

set_index_literal

  $obj->set_index_literal($i, $val);

Sets the value of AssociationEnd literal at index $i. Returns self.

add_literal

  $obj->add_literal(@val);

Adds AssociationEnd literal values. Elements of @val must of type UMMF::UML_1_5::Foundation::Core::EnumerationLiteral. Returns $obj.

add_index_literal

  $obj->add_index_literal($i, @val);

Adds AssociationEnd literal values at index $i. Elements of @val must of type UMMF::UML_1_5::Foundation::Core::EnumerationLiteral. Returns $obj.

remove_literal

  $obj->remove_literal(@val);

Removes the AssociationEnd literal values @val. Elements of @val must of type UMMF::UML_1_5::Foundation::Core::EnumerationLiteral. Returns $obj.

clear_literal

  $obj->clear_literal;

Clears the AssociationEnd literal links to UMMF::UML_1_5::Foundation::Core::EnumerationLiteral. Returns $obj.

count_literal

  $obj->count_literal;

Returns the number of elements associated with literal.

END OF DOCUMENT

UMMF documentation Contained in the UMMF distribution. 
# -*- 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::Foundation::Core::Enumeration;

#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
#




#################################################################
# 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::Foundation::Core::DataType



);


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

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





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



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

  no warnings;

  UNIVERSAL::isa($x, 'UMMF::UML_1_5::Foundation::Core::Enumeration')  ;
}



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

  confess("typecheck: $msg: type '" . 'UMMF::UML_1_5::Foundation::Core::Enumeration' . ": value '$x'")
    unless __validate_type($self, $x);
}



sub isaEnumeration { 1 }



sub isaFoundation__Core__Enumeration { 1 }


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


sub __model_name { 'Foundation::Core::Enumeration' }




sub __isAbstract { 0; }


my $__tangram_schema;

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

  $__tangram_schema ||=
  {
   'classes' =>
   [
     'UMMF::UML_1_5::Foundation::Core::Enumeration' =>
     {
       'table' => 'Foundation__Core__Enumeration',
       'abstract' => 0,
       'slots' => 
       { 
	 # Attributes
	 
	 # Associations
	 	 	       'literal'
       => {
	 'type_impl' => 'iarray',
         'class' => 'UMMF::UML_1_5::Foundation::Core::EnumerationLiteral',

                           'table' => 'Foundation__Core__Enumeration__literal', 

                                                               'coll' => 'enumeration',

                  'slot' => 'enumeration_i', 

                                                                      }
      ,
                         },
       'bases' => [  'UMMF::UML_1_5::Foundation::Core::DataType',  ],
       '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
#



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

  # Attributes



  # Associations

  # AssociationEnd 
  #  enumeration 1
  #  <--> 
  #  literal 1..* UMMF::UML_1_5::Foundation::Core::EnumerationLiteral.
    if ( defined $self->{'literal'} ) {
    my $x = $self->{'literal'};
        $self->{'literal'} = [ ];
        $self->set_literal(@$x);
  }
  

  $self;
}


my $__initialize_use;


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

  # $DB::single = 1;

  unless ( ! $__initialize_use ) {
    $__initialize_use = 1;
    $self->__use('UMMF::UML_1_5::Foundation::Core::Namespace');
    $self->__use('UMMF::UML_1_5::Foundation::Core::Element');
    $self->__use('UMMF::UML_1_5::Foundation::Core::ModelElement');
    $self->__use('UMMF::UML_1_5::Foundation::Core::GeneralizableElement');
    $self->__use('UMMF::UML_1_5::Foundation::Core::Classifier');
    $self->__use('UMMF::UML_1_5::Foundation::Core::DataType');
  }

  $self->UMMF::UML_1_5::Foundation::Core::Enumeration::___initialize;
  $self->UMMF::UML_1_5::Foundation::Core::Namespace::___initialize;
  $self->UMMF::UML_1_5::Foundation::Core::Element::___initialize;
  $self->UMMF::UML_1_5::Foundation::Core::ModelElement::___initialize;
  $self->UMMF::UML_1_5::Foundation::Core::GeneralizableElement::___initialize;
  $self->UMMF::UML_1_5::Foundation::Core::Classifier::___initialize;
  $self->UMMF::UML_1_5::Foundation::Core::DataType::___initialize;

  $self;
}
      


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

  # $DB::single = 1;
  $self->UMMF::UML_1_5::Foundation::Core::Enumeration::___create(@args);
  $self->UMMF::UML_1_5::Foundation::Core::Namespace::___create();
  $self->UMMF::UML_1_5::Foundation::Core::Element::___create();
  $self->UMMF::UML_1_5::Foundation::Core::ModelElement::___create();
  $self->UMMF::UML_1_5::Foundation::Core::GeneralizableElement::___create();
  $self->UMMF::UML_1_5::Foundation::Core::Classifier::___create();
  $self->UMMF::UML_1_5::Foundation::Core::DataType::___create();

  $self;
}




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




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



#################################################################
# AssociationEnd enumeration <---> literal
# type = UMMF::UML_1_5::Foundation::Core::EnumerationLiteral
# multiplicity = 1..*
# ordering = ordered


sub literal ($)
{
  my ($self) = @_;

    my $x = $self->{'literal'} ||= [ ];

  wantarray ? @{$x} : $x;
  
}



sub index_literal ($$@)
{
  my ($self, $i, $count) = @_;

  ;

  my $val = $self->{'literal'} ||= [ ];

  ;

  wantarray ? $val->[$i .. (defined $count ? $i + $count - 1 : $i)]
            : $val->[$i];
}



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

  ;

  my $val = $self->{'literal'} ||= [ ];

  ;

  __ummf_array_index($val, $x);
}



sub set_literal ($@)
{
  my ($self, @val) = @_;
  
  $self->clear_literal;
  $self->add_literal(@val);
}



sub set_index_literal ($$$)
{
  my ($self, $i, $val) = @_;

  ;

  my $x = $self->{'literal'} ||= [ ];

  no warnings;
  my $old;
  if ( ($old = $x->[$i]) ne $val) {
    # Recursion lock
        $x->[$i] = $val
    ;

    # Remove and add associations with other ends.
        
    $old->remove_enumeration($self) if $old;
    $val->add_enumeration($self)    if $val;

  
    ;
  }

  $self;
}



sub add_literal ($@)
{
  my ($self, @val) = @_;
  
    my $x = $self->{'literal'} ||= [ ];
    my $old; # Place holder for other MACRO.
  
  for my $val ( @val ) {
    # Recursion lock
        next if grep($_ eq $val, @$x);
        $self->__use('UMMF::UML_1_5::Foundation::Core::EnumerationLiteral')->__typecheck($val, "UMMF::UML_1_5::Foundation::Core::Enumeration.literal");

    # Recursion lock
        push(@{$x}, $val);
        
    # Remove and add associations with other ends.
        
    $old->remove_enumeration($self) if $old;
    $val->add_enumeration($self)    if $val;

    }
  
  $self;
}



sub add_index_literal ($$@)
{
  my ($self, $i, @val) = @_;

  
    my $x = $self->{'literal'} ||= [ ];
    my $old; # Place holder for other MACRO.
  
  for my $val ( @val ) {
    # Recursion lock
        next if grep($_ eq $val, @$x);
        $self->__use('UMMF::UML_1_5::Foundation::Core::EnumerationLiteral')->__typecheck($val, "UMMF::UML_1_5::Foundation::Core::Enumeration.literal");

    # Recursion lock
        splice(@{$x}, $i, 0, $val); # Recursion lock
        ++ $i;
    
    # Remove and add associations with other ends.
        
    $old->remove_enumeration($self) if $old;
    $val->add_enumeration($self)    if $val;

    }
  
  
  $self;
}



sub remove_literal ($@)
{
  my ($self, @val) = @_;
  
    my $x = $self->{'literal'} ||= [ ];
  
  for my $old ( @val ) {
    # Recursion lock
        my $i; # index of $old in @$x.
    next unless defined($i = __ummf_array_index($x, $old));
    
    my $val = $old;
      
    $self->__use('UMMF::UML_1_5::Foundation::Core::EnumerationLiteral')->__typecheck($val, "UMMF::UML_1_5::Foundation::Core::Enumeration.literal");

    # Recursion lock
        splice(@$x, $i, 1);     
    $val = undef;

    # Remove associations with other ends.

        
    $old->remove_enumeration($self) if $old;
    $val->add_enumeration($self)    if $val;

  ;

  }
  
  $self;
}



sub clear_literal ($) 
{
  my ($self) = @_;
  
    my $x = $self->{'literal'} ||= [ ];
  
  my $val; # Place holder for other MACRO.
  
    $self->{'literal'} = [ ];  # Recursion lock
  for my $old ( @$x ) { # Recursion lock
  
    # Remove associations with other ends.

        
    $old->remove_enumeration($self) if $old;
    $val->add_enumeration($self)    if $val;

  ;

  }
  
  $self;
}



sub count_literal ($)
{
  my ($self) = @_;

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

    defined $x ? scalar @$x : 0;
  }







# End of Class Enumeration



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

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: ###