Changes for page Glossary

Last modified by chrisby on 2024/09/19 10:50

From version 5.3
edited by chrisby
on 2023/02/04 21:41
Change comment: There is no comment for this version
To version 5.7
edited by chrisby
on 2023/03/07 22:27
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -14,43 +14,39 @@
14 14  |Aware/Unaware|(% style="text-align:justify" %)Class A contains a source code reference to class B and is therefore aware of class B. If you only read the source code of class A, you would know that there must be a class B. If there was no such reference, class A would be unaware of class B.
15 15  |Best Practices|(% style="text-align:justify" %)Generally accepted guidelines for increasing your programming productivity. Taking them seriously will save you a lot of pain.
16 16  |Concretion|(% style="text-align:justify" %)(((
17 -It is the counterpart of "abstraction" and is sometimes called "implementation". In OOP it refers to classes that implement methods of interfaces or abstract classes. A concretion defines the internal workings of these abstract functions by providing the "concrete" code.
17 +It is the counterpart to "abstraction" and is sometimes called "implementation". In OOP it refers to non-abstract classes that could implement methods of interfaces or abstract classes. A concretion defines the internal workings of these abstract functions by providing the "concrete" code.
18 18  )))
19 -|[[Constructor Injection>>doc:Software Architecture.Dependency Injection.Types of Dependency Injection.WebHome]]|(% style="text-align:justify" %)Dependency Injection performed by passing a dependency to an instance via constructor argument.
19 +|[[Constructor Injection>>doc:Software Architecture.Dependency Injection.Types of Dependency Injection.WebHome]]|(% style="text-align:justify" %)Dependency injection, which is performed by passing a dependency to an instance via a constructor argument.
20 20  |Component|(((
21 -1. In Spring, it is a generic annotation for a bean that no other Spring Bean Annotation matches: "@Component".
21 +1. In Spring, this is a generic annotation for a bean that does not match any other Spring bean annotation: "@Component".
22 22  1. In software architecture, it is a module that can be executed independently. It is often compiled and/or compressed into an executable such as a .jar or .exe file.
23 23  )))
24 -|Data Structure|(% style="text-align:justify" %)A very simple type of class that contains only data and no logic. For example, a class that has only public fields but no methods. Another form is a class with private fields and simple corresponding getters and setters.
25 -|Dependency|(% style="text-align:justify" %)In the context of classes, a dependency is a field that must be initialized with an instance of another class in order for an object of that class to function properly. Often, the initialization is realized via Dependency Injection.
24 +|Data Structure|(% style="text-align:justify" %)A very simple type of class that contains only data and no logic. For example, a class that has only public fields and no methods. Another form is a class with private fields and simple corresponding getters and setters.
25 +|Dependency|(% style="text-align:justify" %)In the context of classes, a dependency is a member field of one class that must be initialized with an instance of another class in order for an instance of the first class to function properly. This initialization is often done by dependency injection.
26 26  |Dependency Cycle|(% style="text-align:justify" %)For example, an instance of one class requires an instance of another class to be constructed, and vice versa. So both classes need the other dependency to construct an instance. Therefore, it is impossible to construct either instance at all. Always make sure that the dependency graph looks like a directed acyclic graph.
27 -|[[Dependency Injection>>doc:Software Architecture.Dependency Injection.WebHome]] (DI)|(% style="text-align:justify" %)An object is injected with the dependencies it needs instead of constructing them itself.
27 +|[[Dependency Injection>>doc:Software Architecture.Dependency Injection.WebHome]] (DI)|(% style="text-align:justify" %)A technique in which the dependencies an object needs are injected from the outside, rather than constructed within the class.
28 28  |Dirty|(((
29 -(% style="text-align: justify;" %)
30 -~1. Messy, unreadable, or poorly designed code is referred to as "dirty code". Often associated with code written "quick-and-dirty" due to time pressure.
31 -
32 -(% style="text-align: justify;" %)
33 -2. The term comes from the phrase "getting one's hands dirty" and refers to coding work that is considered monotonous, detailed, low-level and undemanding, but necessary. The term is often used in the context of I/O operations. Creating a database transaction, for example, is always handled very similarly and is not considered a fun task for experienced programmers who have done it many times. High-level design is more exciting because it requires more creativity from the developer and is more intellectually stimulating.
29 +~1. Messy, unreadable, or poorly designed code is referred to as "dirty code". Often associated with code written "quick-and-dirty" due to the time constraints of a software project.2. The term comes from the phrase "getting one's hands dirty" and refers to coding work that is considered monotonous, detailed, low-level, or undemanding, but necessary. The term is often used in the context of I/O operations. For example, creating a database transaction, is often done in a similar way and is not considered fun by experienced programmers who have done it many times. High-level design is more exciting because it requires more creativity from the developer and is more intellectually stimulating.
34 34  )))
35 35  |Dynamic|(((
36 36  (% style="text-align: justify;" %)
37 -Often refers to processes which appear at runtime when the code has already been executed and is "running". Examples:
33 +Often refers to processes that appear at run time when the code has already been executed and is "running". Examples:
38 38  
39 -* Dynamic dependencies are dependencies which can be replaced at runtime.
35 +* Dynamic dependencies are dependencies that can be replaced at runtime.
40 40  * Dynamically typed languages determine the type of an object at runtime.
41 41  )))
42 42  |Entity|(((
43 43  (% style="text-align: justify;" %)
44 -~1. In an object context, this means that two objects of the same type that contain exactly the same values in their fields can be considered equivalent, but are still two separately existing entities.
40 +~1. In an object context, this means that two objects of the same type that contain exactly the same values in their fields can be considered equivalent, but are still two separate entities.
45 45  
46 46  (% style="text-align: justify;" %)
47 -2. In the context of software architecture, the term refers to classes that represent the model of the application and often represent things from the real world. For example, a banking application may have entity classes such as //Account//, //Order//, //Customer//, or //Employee//. They are often built like simple Data Structures, but may contain additional validation logic to impose logical constraints on their fields. For example, the integer field //customer.age// must always be between 0 and 150 because that is a logical constraint on people's ages, even though the integer data range is technically much larger.
43 +2. In the context of software architecture, the term refers to classes that represent the data model of the application. For example, a banking application may have entity classes such as //account//, //order//, //customer//, or //employee//. They are often built like simple data structures, but may contain additional validation logic to impose logical constraints on their fields. For example, the integer field //customer.age// must always be between 0 and 120 because this is a logical constraint on the age of people, even though the integer data range is technically much larger.
48 48  )))
49 -|[[Field Injection>>doc:Software Architecture.Dependency Injection.Types of Dependency Injection.WebHome]]|(% style="text-align:justify" %)Dependency Injection is performed by forcibly injecting a dependency into an instance through the use of reflections that break even the encapsulation measures. This type of Dependency Injection is to be avoided.
50 -|[[Inversion of Control>>doc:Software Architecture.Dependency Injection.Dependency Injection Explained.WebHome]] (IoC)|(% style="text-align:justify" %)Transfers the responsibility of defining the logic and order of Dependency Injections from the developer to computer.
45 +|[[Field Injection>>doc:Software Architecture.Dependency Injection.Types of Dependency Injection.WebHome]]|(% style="text-align:justify" %)A type of dependency injection that is performed by forcibly injecting a dependency into an instance through the use of reflections that break even the encapsulation of private fields. This type of dependency injection should be avoided.
46 +|[[Inversion of Control>>doc:Software Architecture.Dependency Injection.Dependency Injection Explained.WebHome]] (IoC)|(% style="text-align:justify" %)Shifts the responsibility for defining the logic and order of dependency injections from the developer to the computer.
51 51  |JavaBean|(((
52 52  (% style="text-align: justify;" %)
53 -A design convention for data structures. Usually it means a class which has:
49 +A design convention for data structures. Usually it means a class that has
54 54  
55 55  * a public no-argument constructor
56 56  * only private fields
... ... @@ -57,35 +57,35 @@
57 57  * only getters and setters for each field as methods
58 58  
59 59  (% style="text-align: justify;" %)
60 -Often, DTO's and entities follow this convention.
56 +Often DTOs and entities follow this convention.
61 61  )))
62 -|Logic|(% style="text-align:justify" %)Any code with non-trivial complexity can be referred to as "logic". In contrast, for example, getters and setters have trivial complexity.
63 -|Magic|(% style="text-align:justify" %)"Code that handles complex tasks while hiding that complexity to present a simple interface."^^[[[sources]>>url:https://en.wikipedia.org/wiki/Magic_(programming)]]^^ For example, the introduction of the Spring IoC container is quite simple, but the logic and wiring that goes on in the background is complex.
64 -|Pain|(% style="text-align:justify" %)Something causes pain when somebody spend unnecessary and great effort on a task that often could have been prevented by better code design.
65 -|Production Code|(% style="text-align:justify" %)The counterpart of the Test Code. It contains all the code required to run the application.
58 +|Logic|(% style="text-align:justify" %)Any code with non-trivial complexity can be called "logic". In contrast, for example, getters and setters have trivial complexity.
59 +|Magic|(% style="text-align:justify" %)"Code that handles complex tasks while hiding that complexity to present a simple interface."^^[[[sources]>>url:https://en.wikipedia.org/wiki/Magic_(programming)]]^^ For example, the introduction of an IoC container is often quite simple, but the logic and wiring that goes on in the background is complex.
60 +|Pain|(% style="text-align:justify" %)Something causes pain when someone spends unnecessary effort on a task that could often have been avoided by better code design.
61 +|Production Code|(% style="text-align:justify" %)The counterpart to the Test Code. It contains all the code needed to run the application.
66 66  |Runtime|(((
67 67  (% style="text-align: justify;" %)
68 -The time period in which the code is executed. For example:
64 +The period of time during which the code is executed. For example:
69 69  
70 -* An exception is thrown by the compiler that finds an invalid syntax in the source code. This is called a compile-time exception.
66 +* An exception is thrown by the compiler that finds invalid syntax in the source code. This is called a compile-time exception.
71 71  * Suppose that after a successful compilation, an executable file was created, started, and an exception was thrown shortly thereafter. Since this happened at runtime, it is a runtime exception.
72 72  )))
73 -|Separation of Concerns|(% style="text-align:justify" %)A principle that says that programs should be modular, with each module taking care of a different aspect of the program.
74 -|[[Setter Injection>>doc:Software Architecture.Dependency Injection.Types of Dependency Injection.WebHome]]|(% style="text-align:justify" %)Dependency Injection performed by passing a dependency to an instance via setter method argument.
69 +|Separation of Concerns|(% style="text-align:justify" %)A principle that says that software should be structured modular, with each module dealing with a different aspect of the program. This is intended to give the software a clear, understandable architecture.
70 +|[[Setter Injection>>doc:Software Architecture.Dependency Injection.Types of Dependency Injection.WebHome]]|(% style="text-align:justify" %)A type of dependency injection, which is performed by passing a dependency to an instance via a setter method argument.
75 75  |Spring Bean|(((
76 76  (% style="text-align: justify;" %)
77 -A term used in Spring Framework for an object that is contained in the IoC container to be injected into other beans and/or to receive dependency injections. It is one of many components/beans that are wired together via IoC to form the application when it is started.
73 +A term used in the Spring Framework for an object that is contained in the IoC container to be injected into other beans and/or to receive dependency injections. It is one of many components/beans that are wired together via IoC to form the application when it is started.
78 78  
79 79  (% style="text-align: justify;" %)
80 -Not to be confused with JavaBeans.
76 +It should not be confused with JavaBeans.
81 81  )))
82 82  |Static|(((
83 83  (% style="text-align: justify;" %)
84 -Often refers to processes that depend non-running code. Examples:
80 +Often refers to processes that depend on non-running code. Examples:
85 85  
86 -* Static Code Analysis Tools can examine source code files for possible improvements.
82 +* Static code analysis tools can examine source code files for possible improvements.
87 87  * Statically typed languages determine the type of an object at compile time.
88 88  )))
89 -|Test Code|(% style="text-align:justify" %)The counterpart of the Production Code. It is code that checks whether the production code works as expected. Test Code plays no role in the operation of an application.
85 +|Test Code|(% style="text-align:justify" %)The counterpart to the Production Code. It is code that checks that the production code works as expected. Test code has no role in the operation of an application.
90 90  |Test-Driven Development|(% style="text-align:justify" %)A workflow in which the developer implements code in small steps, incrementally and iteratively, defining tests at each iteration.
91 -|Wiring|(% style="text-align:justify" %)The process of generating and injecting dependencies to set up an application performed by the IoC container.
87 +|Wiring|(% style="text-align:justify" %)The process of generating and injecting dependencies to start an application, performed by the IoC container.