KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > cayenne > reflect > ArcProperty


1 /*****************************************************************
2  * Licensed to the Apache Software Foundation (ASF) under one
3  * or more contributor license agreements. See the NOTICE file
4  * distributed with this work for additional information
5  * regarding copyright ownership. The ASF licenses this file
6  * to you under the Apache License, Version 2.0 (the
7  * "License"); you may not use this file except in compliance
8  * with the License. You may obtain a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing,
13  * software distributed under the License is distributed on an
14  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15  * KIND, either express or implied. See the License for the
16  * specific language governing permissions and limitations
17  * under the License.
18  ****************************************************************/
19
20 package org.apache.cayenne.reflect;
21
22 import org.apache.cayenne.map.ObjRelationship;
23
24 /**
25  * A Property that represents an "arc" connecting source node to the target node in the
26  * graph.
27  *
28  * @since 1.2
29  * @author Andrus Adamchik
30  */
31 public interface ArcProperty extends Property {
32
33     /**
34      * Returns a relationship associated with this arc.
35      *
36      * @since 3.0
37      */
38     ObjRelationship getRelationship();
39
40     /**
41      * Returns a complimentary reverse ArcProperty or null if no reverse arc exists.
42      */
43     ArcProperty getComplimentaryReverseArc();
44
45     /**
46      * Returns a ClassDescriptor for the type of graph nodes pointed to by this arc
47      * property. Note that considering that a target object may be a subclass of the class
48      * handled by the descriptor, users of this method may need to call
49      * {@link ClassDescriptor#getSubclassDescriptor(Class)} before using the descriptor to
50      * access objects.
51      */
52     ClassDescriptor getTargetDescriptor();
53
54     /**
55      * Returns whether a target node connected to a given object is an unresolved fault.
56      *
57      * @param source an object that is a source object of the relationship.
58      */
59     boolean isFault(Object JavaDoc source);
60
61     /**
62      * Turns a property of an object into a fault.
63      *
64      * @since 3.0
65      */
66     void invalidate(Object JavaDoc object);
67 }
68
Popular Tags