¡@

Home 

OpenStack Study: base_filter.py

OpenStack Index

**** CubicPower OpenStack Study ****

# Copyright (c) 2011-2012 OpenStack Foundation.

# All Rights Reserved.

#

# Licensed under the Apache License, Version 2.0 (the "License"); you may

# not use this file except in compliance with the License. You may obtain

# a copy of the License at

#

# http://www.apache.org/licenses/LICENSE-2.0

#

# Unless required by applicable law or agreed to in writing, software

# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT

# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the

# License for the specific language governing permissions and limitations

# under the License.

"""

Filter support

"""

from cinder.openstack.common.scheduler import base_handler

**** CubicPower OpenStack Study ****

class BaseFilter(object):

"""Base class for all filter classes."""

**** CubicPower OpenStack Study ****

    def _filter_one(self, obj, filter_properties):

        """Return True if it passes the filter, False otherwise.

        Override this in a subclass.

        """

        return True

**** CubicPower OpenStack Study ****

    def filter_all(self, filter_obj_list, filter_properties):

        """Yield objects that pass the filter.

        Can be overridden in a subclass, if you need to base filtering

        decisions on all objects.  Otherwise, one can just override

        _filter_one() to filter a single object.

        """

        for obj in filter_obj_list:

            if self._filter_one(obj, filter_properties):

                yield obj

**** CubicPower OpenStack Study ****

class BaseFilterHandler(base_handler.BaseHandler):

"""Base class to handle loading filter classes.

This class should be subclassed where one needs to use filters.

"""

**** CubicPower OpenStack Study ****

    def get_filtered_objects(self, filter_classes, objs,

                             filter_properties):

        for filter_cls in filter_classes:

            objs = filter_cls().filter_all(objs, filter_properties)

        return list(objs)